pub struct Artifact { /* private fields */ }Expand description
A generated artifact: title, kind, source, and versions.
Implementations§
Source§impl Artifact
impl Artifact
Sourcepub fn new(
id: impl Into<SharedString>,
title: impl Into<SharedString>,
source: StreamedContent,
) -> Self
pub fn new( id: impl Into<SharedString>, title: impl Into<SharedString>, source: StreamedContent, ) -> Self
Creates an artifact with its title and source.
Sourcepub fn kind(self, kind: ArtifactKind) -> Self
pub fn kind(self, kind: ArtifactKind) -> Self
Sets the kind (default ArtifactKind::Code).
Sourcepub fn language(self, language: impl Into<SharedString>) -> Self
pub fn language(self, language: impl Into<SharedString>) -> Self
Sets the language used to highlight the source.
Sourcepub fn versions(
self,
versions: impl IntoIterator<Item = ArtifactVersion>,
) -> Self
pub fn versions( self, versions: impl IntoIterator<Item = ArtifactVersion>, ) -> Self
Sets the produced versions, oldest first.
Sourcepub fn active_version(self, version_id: impl Into<SharedString>) -> Self
pub fn active_version(self, version_id: impl Into<SharedString>) -> Self
Selects the shown version by ID.
Sourcepub fn artifact_kind(&self) -> ArtifactKind
pub fn artifact_kind(&self) -> ArtifactKind
Returns the kind.
Sourcepub fn source(&self) -> &StreamedContent
pub fn source(&self) -> &StreamedContent
Returns the source with its lifecycle.
Sourcepub fn version_refs(&self) -> &[ArtifactVersion]
pub fn version_refs(&self) -> &[ArtifactVersion]
Returns the versions, oldest first.
Sourcepub fn active_version_index(&self) -> Option<usize>
pub fn active_version_index(&self) -> Option<usize>
Returns the index of the active version (the last one by default).
Sourcepub fn accessibility_label(&self) -> String
pub fn accessibility_label(&self) -> String
The accessible name: title, kind, and lifecycle.
Trait Implementations§
impl Eq for Artifact
impl StructuralPartialEq for Artifact
Auto Trait Implementations§
impl Freeze for Artifact
impl RefUnwindSafe for Artifact
impl Send for Artifact
impl Sync for Artifact
impl Unpin for Artifact
impl UnsafeUnpin for Artifact
impl UnwindSafe for Artifact
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key.
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Instruments this type with the provided [
Span], returning an
Instrumented wrapper.§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
Attaches the provided
Subscriber to this type, returning a
[WithDispatch] wrapper.