Struct Target 

pub struct Target { /* private fields */ }

A directory devset manages.

Implementations

impl Target

pub fn find(dir: &Utf8Path) -> Result<Self>

The target containing dir: the nearest ancestor holding .devset/config.toml.

Errors

• TargetError::NotFound, no ancestor holds one.
• TargetError::OldConfig, its config.toml is devset 0.1’s.
• Error::Parse, one of its files does not parse.

pub fn open_or_new(root: &Utf8Path) -> Result<Self>

The target rooted at root, or a new one there, its config.toml a commented skeleton. Never one inside another target.

Errors

• TargetError::Nested, root lies inside another target.
• TargetError::OldConfig, its config.toml is devset 0.1’s.
• Error::Parse, one of its files does not parse.

pub fn root(&self) -> &Utf8Path

The directory holding .devset/.

pub const fn config(&self) -> &Config

config.toml.

pub fn exists(&self) -> bool

Whether config.toml exists yet: a new target’s is written by its first commit.

pub fn add_source(&mut self, name: SourceName, source: Source) -> Result<()>

Names source name in [sources]; written by the next commit.

Nothing changes when it already does.

Errors

• TargetError::SourceExists, name already names another source.
• Error::Parse, sources in config.toml is not a table.

pub fn add_layer(&mut self, layer: LayerSpec) -> Result<()>

Appends layer as the last layer; written by the next commit.

Errors

• TargetError::DuplicateLayer, a layer already applies the profile.
• TargetError::NoSuchSource, [sources] does not name its source.
• Error::Parse, layers in config.toml is not a list of tables.

pub fn layer(&self, name: &ProfileName) -> Option<&LayerSpec>

The layer that applies the profile named name.

pub fn remove_layer(&mut self, name: &ProfileName) -> Result<()>

Removes the layer that applies the profile named name; written by the next commit. Its source stays, for another layer to use.

Every [files] override that picks it, from = "<name>", goes with it.

Errors

Error::Parse, config.toml changed shape so that the layer cannot be found in it.

pub fn remove_override(&mut self, path: &RelPath) -> Result<()>

Removes the [files."path"] override; written by the next commit.

Errors

Error::Parse, as add_layer.

pub fn answer(&mut self, name: VarName, value: String)

Answers name; written by the next commit.

pub const fn answers(&self) -> &BTreeMap<VarName, String>

Every answer: recorded, or given since.

pub fn rescaffold(&mut self, scaffold: ScaffoldId)

Writes the absent files of scaffold again at the next survey, whatever was decided of it.

pub fn pinned(&self, source: &Source) -> Option<&Oid>

The commit the lock pins source to.

Found by source, not position, so removing or reordering layers leaves the others pinned.

Trait Implementations

impl Debug for Target

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

Formats the value using the given formatter.