Template

Struct Template 

Source
pub struct Template { /* private fields */ }
Expand description

A struct representing a wrut template.

Implementations§

Source§

impl Template

Source

pub fn from(path: impl Into<PathBuf>, name: Option<&str>) -> Result<Self>

Create a new Template struct given a path and an optional name.

§Arguments
  • path - The path to a directory
  • name - The name of the template
    • If name is None, then the directory name of path provided will be used.
Source

pub fn get(name: &str) -> Result<Self>

Get an existing Template struct given its name.

If no such project exists, it will return an error.

Source

pub fn list() -> Result<Vec<String>>

Get a Vec<String> of containing a list of all currently registered projects.

Source

pub fn init(self) -> Result<Self>

Initialize a template.

This function will create a .wrut.toml file in the provided directory and register a symlink to dir in ~/.wrut/templates.

Source

pub fn add_tags(self, tags: &Vec<String>) -> Result<Self>

Add tags to a template.

Source

pub fn remove(&self, delete: bool) -> Result<()>

Remove the given project.

§Arguments
  • delete - If delete is true, the project directory will be deleted. If false, then the project will only be unregistered from ~/.wrut/projects.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.