Enum CompanionDiscovery 

pub enum CompanionDiscovery {
    Beside,
    Ancestors,
    DocsSubdir,
}

Where a family searches for companion documents relative to contract inputs.

Variants

Beside

Search in the same directory as the contract file.

Ancestors

Walk ancestor directories from the contract file location.

DocsSubdir

Search a docs/ subdirectory relative to the contract root.

Trait Implementations

impl Clone for CompanionDiscovery

fn clone(&self) -> CompanionDiscovery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CompanionDiscovery

impl Debug for CompanionDiscovery

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

Formats the value using the given formatter.

impl Eq for CompanionDiscovery

impl PartialEq for CompanionDiscovery

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

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

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 StructuralPartialEq for CompanionDiscovery