Struct ConfiguredRoot 

pub struct ConfiguredRoot(/* private fields */);

A non-empty workspace.roots entry, kept as written.

An empty path is is_relative() and joins onto a base directory as that directory, which is almost never what an empty string in a config file was meant to say, so it is rejected when the value is built or deserialized.

Examples

use mcpls_core::config::ConfiguredRoot;

let root = ConfiguredRoot::new("/work/project").unwrap();
assert_eq!(root.as_path(), std::path::Path::new("/work/project"));
assert!(ConfiguredRoot::new("").is_err());

Implementations

impl ConfiguredRoot

pub fn new(root: impl Into<PathBuf>) -> Result<Self, InvalidWorkspaceRoot>

Builds a root from any path.

Errors

Returns InvalidWorkspaceRoot if root is empty.

pub fn as_path(&self) -> &Path

The root as written.

Trait Implementations

impl AsRef<Path> for ConfiguredRoot

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ConfiguredRoot

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfiguredRoot

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfiguredRoot

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ConfiguredRoot

impl From<ConfiguredRoot> for PathBuf

fn from(root: ConfiguredRoot) -> Self

Converts to this type from the input type.

impl Hash for ConfiguredRoot

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ConfiguredRoot

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ConfiguredRoot

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ConfiguredRoot

impl TryFrom<PathBuf> for ConfiguredRoot

type Error = InvalidWorkspaceRoot

The type returned in the event of a conversion error.

fn try_from(root: PathBuf) -> Result<Self, Self::Error>

Performs the conversion.