[−][src]Enum rustdoc::clean::DocFragment

pub enum DocFragment {
    SugaredDoc(usize, Span, String),
    RawDoc(usize, Span, String),
    Include(usize, Span, String, String),
}

A portion of documentation, extracted from a #[doc] attribute.

Each variant contains the line number within the complete doc-comment where the fragment starts, as well as the Span where the corresponding doc comment or attribute is located.

Included files are kept separate from inline doc comments so that proper line-number information can be given when a doctest fails. Sugared doc comments and "raw" doc comments are kept separate because of issue #42760.

Variants

SugaredDoc(usize, Span, String)

A doc fragment created from a /// or //! doc comment.

RawDoc(usize, Span, String)

A doc fragment created from a "raw" #[doc=""] attribute.

Include(usize, Span, String, String)

A doc fragment created from a #[doc(include="filename")] attribute. Contains both the given filename and the file contents.

Methods

`impl DocFragment`
[src]

`pub fn as_str(&self) -> &str`
[src]

`pub fn span(&self) -> Span`
[src]

`impl DocFragment`
[src]

`fn kind(&self) -> DocFragmentKind`
[src]

Trait Implementations

`impl Clone for DocFragment`
[src]

`fn clone(&self) -> DocFragment`
[src]

Returns a copy of the value. Read more

`fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

Performs copy-assignment from source. Read more

`impl Encodable for DocFragment`
[src]

`fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), __S::Error>`
[src]

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

`impl Decodable for DocFragment`
[src]

`fn decode<D: Decoder>(d: &mut D) -> Result<DocFragment, __D::Error>`
[src]

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

`impl PartialEq for DocFragment`
[src]

`fn eq(&self, other: &DocFragment) -> bool`
[src]

This method tests for self and other values to be equal, and is used by ==. Read more

`fn ne(&self, other: &DocFragment) -> bool`
[src]

This method tests for !=.

`impl Eq for DocFragment`
[src]

`fn assert_receiver_is_total_eq(&self)`
[src]

`impl Debug for DocFragment`
[src]

`fn fmt(&self, f: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. Read more

`impl Hash for DocFragment`
[src]

`fn hash<H: Hasher>(&self, state: &mut H)`
[src]

Feeds this value into the given [Hasher]. Read more

`fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,`
1.3.0
[src]

Feeds a slice of this type into the given [Hasher]. Read more

`impl<'a> FromIterator<&'a DocFragment> for String`
[src]

`fn from_iter<T>(iter: T) -> Self where T: IntoIterator<Item = &'a DocFragment>,`
[src]

Creates a value from an iterator. Read more

Auto Trait Implementations

`impl !Send for DocFragment`

`impl !Sync for DocFragment`

Blanket Implementations

`impl<T> ToOwned for T where T: Clone,`
[src]

`type Owned = T`

`fn to_owned(&self) -> T`
[src]

Creates owned data from borrowed data, usually by cloning. Read more

`fn clone_into(&self, target: &mut T)`
[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

`impl<T> From for T`
[src]

`fn from(t: T) -> T`
[src]

Performs the conversion.

`impl<T, U> Into for T where U: From<T>,`
[src]

`fn into(self) -> U`
[src]

Performs the conversion.

`impl<T, U> TryFrom for T where T: From,`
[src]

`type Error = !`

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`
[src]

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

`impl<T> Borrow for T where T: ?Sized,`
[src]

ⓘImportant traits for &'a mut R
Important traits for &'a mut R
`impl<'a, R> Read for &'a mut R where R: Read + ?Sized, impl<'a, W> Write for &'a mut W where W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where I: Iterator + ?Sized, type Item = ::Item;`
`fn borrow(&self) -> &T`
[src]

Immutably borrows from an owned value. Read more

`impl<T, U> TryInto for T where U: TryFrom<T>,`
[src]

`type Error = >::Error`

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`
[src]

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

`impl<T> BorrowMut for T where T: ?Sized,`
[src]

ⓘImportant traits for &'a mut R
Important traits for &'a mut R
`impl<'a, R> Read for &'a mut R where R: Read + ?Sized, impl<'a, W> Write for &'a mut W where W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where I: Iterator + ?Sized, type Item = ::Item;`
`fn borrow_mut(&mut self) -> &mut T`
[src]

Mutably borrows from an owned value. Read more

`impl<T> Any for T where T: 'static + ?Sized,`
[src]

`fn get_type_id(&self) -> TypeId`
[src]

🔬 This is a nightly-only experimental API. (get_type_id)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

`impl<T> Encodable for T where T: UseSpecializedEncodable + ?Sized,`
[src]

`fn encode<E>(&self, e: &mut E) -> Result<(), <E as Encoder>::Error> where E: Encoder,`
[src]

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

`impl<T> Decodable for T where T: UseSpecializedDecodable,`
[src]

`fn decode<D>(d: &mut D) -> Result<T, <D as Decoder>::Error> where D: Decoder,`
[src]

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

`impl<E> SpecializationError for E`
[src]

`fn not_found<S, T>(trait_name: &'static str, method_name: &'static str) -> E where T: ?Sized,`
[src]

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Create an error for a missing method specialization. Defaults to panicking with type, trait & method names. S is the encoder/decoder state type, T is the type being encoded/decoded, and the arguments are the names of the trait and method that should've been overridden. Read more

`impl<T> Erased for T`
[src]

`impl<T> Send for T where T: ?Sized,`
[src]

`impl<T> Sync for T where T: ?Sized,`
[src]

`impl<T> Erased for T`

`impl<T> MaybeResult for T`
[src]

`fn from_ok(x: T) -> T`
[src]

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

`fn map_same<F>(self, f: F) -> T where F: FnOnce(T) -> T,`
[src]

🔬 This is a nightly-only experimental API. (rustc_private)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

[−][src]Enum rustdoc::clean::DocFragment

Variants

Methods

impl DocFragment[src]

pub fn as_str(&self) -> &str[src]

pub fn span(&self) -> Span[src]

impl DocFragment[src]

fn kind(&self) -> DocFragmentKind[src]

Trait Implementations

impl Clone for DocFragment[src]

fn clone(&self) -> DocFragment[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Encodable for DocFragment[src]

fn encode<__S: Encoder>(&self, s: &mut __S) -> Result<(), __S::Error>[src]

impl Decodable for DocFragment[src]

fn decode<__D: Decoder>(d: &mut __D) -> Result<DocFragment, __D::Error>[src]

impl PartialEq for DocFragment[src]

fn eq(&self, other: &DocFragment) -> bool[src]

fn ne(&self, other: &DocFragment) -> bool[src]

impl Eq for DocFragment[src]

fn assert_receiver_is_total_eq(&self)[src]

impl Debug for DocFragment[src]

fn fmt(&self, f: &mut Formatter) -> Result[src]

impl Hash for DocFragment[src]

fn hash<__H: Hasher>(&self, state: &mut __H)[src]

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher, 1.3.0[src]

impl<'a> FromIterator<&'a DocFragment> for String[src]

fn from_iter<T>(iter: T) -> Self where T: IntoIterator<Item = &'a DocFragment>, [src]

Auto Trait Implementations

impl !Send for DocFragment

impl !Sync for DocFragment

Blanket Implementations

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

fn to_owned(&self) -> T[src]

fn clone_into(&self, target: &mut T)[src]

impl<T> From for T[src]

fn from(t: T) -> T[src]

impl<T, U> Into for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T, U> TryFrom for T where T: From<U>, [src]

type Error = !

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

impl<T> Borrow for T where T: ?Sized, [src]

ⓘImportant traits for &'a mut RImportant traits for &'a mut Rimpl<'a, R> Read for &'a mut R where R: Read + ?Sized, impl<'a, W> Write for &'a mut W where W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;fn borrow(&self) -> &T[src]

Important traits for &'a mut R

impl<T, U> TryInto for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

impl<T> BorrowMut for T where T: ?Sized, [src]

Important traits for &'a mut R

impl<T> Any for T where T: 'static + ?Sized, [src]

fn get_type_id(&self) -> TypeId[src]

impl<T> Encodable for T where T: UseSpecializedEncodable + ?Sized, [src]

fn encode<E>(&self, e: &mut E) -> Result<(), <E as Encoder>::Error> where E: Encoder, [src]

impl<T> Decodable for T where T: UseSpecializedDecodable, [src]

fn decode<D>(d: &mut D) -> Result<T, <D as Decoder>::Error> where D: Decoder, [src]

impl<E> SpecializationError for E[src]

fn not_found<S, T>(trait_name: &'static str, method_name: &'static str) -> E where T: ?Sized, [src]

impl<T> Erased for T[src]

impl<T> Send for T where T: ?Sized, [src]

impl<T> Sync for T where T: ?Sized, [src]

impl<T> Erased for T

impl<T> MaybeResult for T[src]

fn from_ok(x: T) -> T[src]

fn map_same<F>(self, f: F) -> T where F: FnOnce(T) -> T, [src]

impl<'a, T> Captures for T where T: ?Sized, [src]

`impl DocFragment`
[src]

`pub fn as_str(&self) -> &str`
[src]

`pub fn span(&self) -> Span`
[src]

`impl DocFragment`
[src]

`fn kind(&self) -> DocFragmentKind`
[src]

`impl Clone for DocFragment`
[src]

`fn clone(&self) -> DocFragment`
[src]

`fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

`impl Encodable for DocFragment`
[src]

`fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), __S::Error>`
[src]

`impl Decodable for DocFragment`
[src]

`fn decode<D: Decoder>(d: &mut D) -> Result<DocFragment, __D::Error>`
[src]

`impl PartialEq for DocFragment`
[src]

`fn eq(&self, other: &DocFragment) -> bool`
[src]

`fn ne(&self, other: &DocFragment) -> bool`
[src]

`impl Eq for DocFragment`
[src]

`fn assert_receiver_is_total_eq(&self)`
[src]

`impl Debug for DocFragment`
[src]

`fn fmt(&self, f: &mut Formatter) -> Result`
[src]

`impl Hash for DocFragment`
[src]

`fn hash<H: Hasher>(&self, state: &mut H)`
[src]

`fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,`
1.3.0
[src]

`impl<'a> FromIterator<&'a DocFragment> for String`
[src]

`fn from_iter<T>(iter: T) -> Self where T: IntoIterator<Item = &'a DocFragment>,`
[src]

`impl !Send for DocFragment`

`impl !Sync for DocFragment`

`impl<T> ToOwned for T where T: Clone,`
[src]

`type Owned = T`

`fn to_owned(&self) -> T`
[src]

`fn clone_into(&self, target: &mut T)`
[src]

`impl<T> From for T`
[src]

`fn from(t: T) -> T`
[src]

`impl<T, U> Into for T where U: From<T>,`
[src]

`fn into(self) -> U`
[src]

`impl<T, U> TryFrom for T where T: From<U>,`
[src]

`type Error = !`

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`
[src]

`impl<T> Borrow for T where T: ?Sized,`
[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,`
[src]

`type Error = <U as TryFrom<T>>::Error`

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`
[src]

`impl<T> BorrowMut for T where T: ?Sized,`
[src]

`impl<T> Any for T where T: 'static + ?Sized,`
[src]

`fn get_type_id(&self) -> TypeId`
[src]

`impl<T> Encodable for T where T: UseSpecializedEncodable + ?Sized,`
[src]

`fn encode<E>(&self, e: &mut E) -> Result<(), <E as Encoder>::Error> where E: Encoder,`
[src]

`impl<T> Decodable for T where T: UseSpecializedDecodable,`
[src]

`fn decode<D>(d: &mut D) -> Result<T, <D as Decoder>::Error> where D: Decoder,`
[src]

`impl<E> SpecializationError for E`
[src]

`fn not_found<S, T>(trait_name: &'static str, method_name: &'static str) -> E where T: ?Sized,`
[src]

`impl<T> Erased for T`
[src]

`impl<T> Send for T where T: ?Sized,`
[src]

`impl<T> Sync for T where T: ?Sized,`
[src]

`impl<T> Erased for T`

`impl<T> MaybeResult for T`
[src]

`fn from_ok(x: T) -> T`
[src]

`fn map_same<F>(self, f: F) -> T where F: FnOnce(T) -> T,`
[src]

`impl<'a, T> Captures for T where T: ?Sized,`
[src]