Struct ProjectMarker 

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

The file or directory name whose presence marks a project root, such as Cargo.toml.

Exactly one file name: an absolute path would always match and a multi-component path would match at the workspace root but never deeper. Deserializes from a TOML string and rejects both at load time.

Examples

use mcpls_core::config::ProjectMarker;

assert_eq!(ProjectMarker::new("Cargo.toml").unwrap(), "Cargo.toml");
assert!(ProjectMarker::new("/etc/hosts").is_err());
assert!(ProjectMarker::new("src/lib.rs").is_err());
assert!(ProjectMarker::new("..").is_err());

Implementations

impl ProjectMarker

pub const fn from_static(text: &'static str) -> Self

Builds the value from a literal, checked at compile time when evaluated in a const context.

Panics

Panics if the literal is not a valid value of this type.

pub fn new(text: impl Into<String>) -> Result<Self, InvalidProjectMarker>

Builds the value from any string.

Errors

Returns InvalidProjectMarker naming the first rule text breaks.

impl ProjectMarker

pub fn as_str(&self) -> &str

The validated text.

Trait Implementations

impl AsRef<str> for ProjectMarker

fn as_ref(&self) -> &str

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

impl Borrow<str> for ProjectMarker

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for ProjectMarker

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 ProjectMarker

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProjectMarker

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ProjectMarker

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

Formats the value using the given formatter.

impl Eq for ProjectMarker

impl From<ProjectMarker> for String

fn from(value: ProjectMarker) -> Self

Converts to this type from the input type.

impl FromStr for ProjectMarker

type Err = InvalidProjectMarker

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ProjectMarker

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 ProjectMarker

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for ProjectMarker

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for ProjectMarker

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProjectMarker

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 ProjectMarker

impl TryFrom<String> for ProjectMarker

type Error = InvalidProjectMarker

The type returned in the event of a conversion error.

fn try_from(text: String) -> Result<Self, Self::Error>

Performs the conversion.