Enum ContentOrigin

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

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 duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContentOrigin

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

Formats the value using the given formatter.

impl Display for ContentOrigin

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

Formats the value using the given formatter.

impl Hash for ContentOrigin

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ContentOrigin

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ContentOrigin

impl StructuralPartialEq for ContentOrigin