Enum doc_chunks::chunk::ContentOrigin

source · [−]

pub enum ContentOrigin {
    CargoManifestDescription(PathBuf),
    CommonMarkFile(PathBuf),
    RustDocTest(PathBuf, Span),
    RustSourceFile(PathBuf),
    TestEntityRust,
    TestEntityCommonMark,
}

Expand description

Definition of the source of a checkable chunk

Variants

`CargoManifestDescription(PathBuf)`

A Cargo.toml manifest that contains a description field.

`CommonMarkFile(PathBuf)`

A common mark file at given path.

`RustDocTest(PathBuf, Span)`

A rustdoc comment, part of file reference by path in span.

`RustSourceFile(PathBuf)`

Full rust source file.

`TestEntityRust`

A test entity for a rust file, with no meaning outside of test.

`TestEntityCommonMark`

A test entity for a cmark file, with no meaning outside of test.

Implementations

impl ContentOrigin

pub fn as_path(&self) -> &Path

Represent the content origin as path.

For unit and integration tests, two additional hardcoded variants are available, which resolve to static paths: TestEntityRust variant becomes /tmp/test/entity.rs, TestEntityCommonMark variant becomes /tmp/test/entity.md.

Trait Implementations

impl Clone for ContentOrigin

fn clone(&self) -> ContentOrigin

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for ContentOrigin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Display for ContentOrigin

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Hash for ContentOrigin

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

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

impl PartialEq<ContentOrigin> for ContentOrigin

fn eq(&self, other: &ContentOrigin) -> bool

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

fn ne(&self, other: &ContentOrigin) -> bool

This method tests for !=.

impl Eq for ContentOrigin

impl StructuralEq for ContentOrigin

impl StructuralPartialEq for ContentOrigin

Auto Trait Implementations

impl RefUnwindSafe for ContentOrigin

impl Send for ContentOrigin

impl Sync for ContentOrigin

impl Unpin for ContentOrigin

impl UnwindSafe for ContentOrigin

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

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

impl<T> ToString for T where
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.