Struct DocPaths 

pub struct DocPaths {
    pub doc: Vec<String>,
}

A structure of documentation paths.

Fields

doc: Vec<String>

Paths to documentation.

Implementations

impl DocPaths

pub fn new(doc: Vec<String>) -> Self

Creates documentation paths.

pub fn read(r: &mut dyn Read) -> Result<Self>

Reads documentation paths from the reader.

pub fn write(&self, w: &mut dyn Write) -> Result<()>

Writes the documentation paths to the writer.

pub fn load<P: AsRef<Path>>(path: P) -> Result<Self>

Loads documentation paths from the file.

pub fn load_opt<P: AsRef<Path>>(path: P) -> Result<Option<Self>>

Loads documentation paths from the file if the file exists, otherwise this method returns None.

pub fn save<P: AsRef<Path>>(&self, path: P) -> Result<()>

Saves the documentation paths to a file.

Trait Implementations

impl Clone for DocPaths

fn clone(&self) -> DocPaths

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocPaths

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocPaths

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocPaths

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

where __S: Serializer,

Serialize this value into the given Serde serializer.