Struct WritingStyle 

pub struct WritingStyle {
    pub source: WritingSource,
    pub path: Option<String>,
}

The writing-style selection as written.

Fields

source: WritingSource

Which source.

path: Option<String>

The project’s own document, relative to the repository root, where the source is project.

Implementations

impl WritingStyle

pub fn parse_flag(value: &str) -> Result<Self, ConfigError>

Read the --writing-style argument: builtin, none, or project:<path>.

Errors

ConfigError::WritingStyle for any other form, or a path the selection refuses.

pub fn route(&self) -> Option<String>

The document authors are routed to, relative to the repository, or None where the selection installs no route.

pub fn render(&self) -> String

The selection as the declaration file spells it.

Trait Implementations

impl Clone for WritingStyle

fn clone(&self) -> WritingStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WritingStyle

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

Formats the value using the given formatter.

impl Default for WritingStyle

fn default() -> WritingStyle

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WritingStyle

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for WritingStyle

impl PartialEq for WritingStyle

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WritingStyle