Enum DocsRoot 

pub enum DocsRoot {
    Docs,
    UnderscoreDocs,
}

Where an instance keeps the documents the gates read.

Variants

Docs

docs/ — the codebase convention.

UnderscoreDocs

_docs/ — the knowledge-base convention.

Implementations

impl DocsRoot

pub const fn as_str(self) -> &'static str

The directory name.

Trait Implementations

impl Clone for DocsRoot

fn clone(&self) -> DocsRoot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DocsRoot

impl Debug for DocsRoot

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocsRoot

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DocsRoot

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

Formats the value using the given formatter.

impl Eq for DocsRoot

impl Hash for DocsRoot

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 DocsRoot

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DocsRoot

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DocsRoot