Struct FileName 

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

The name of an extensionless file such as Makefile or Dockerfile, as Path::file_name reports it.

A name has no dot, so Path::extension never reports one for it and the extension and name maps cannot both claim a file. Case is significant.

Examples

use mcpls_core::config::FileName;

assert_eq!(FileName::new("Makefile").unwrap(), "Makefile");
assert!(FileName::new("Cargo.toml").is_err());
assert!(FileName::new(".eslintrc").is_err());

Implementations

impl FileName

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, InvalidFileName>

Builds the value from any string.

Errors

Returns InvalidFileName naming the first rule text breaks.

impl FileName

pub fn as_str(&self) -> &str

The validated text.

Trait Implementations

impl AsRef<str> for FileName

fn as_ref(&self) -> &str

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

impl Borrow<str> for FileName

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for FileName

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 FileName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileName

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FileName

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

Formats the value using the given formatter.

impl Eq for FileName

impl From<FileName> for String

fn from(value: FileName) -> Self

Converts to this type from the input type.

impl FromStr for FileName

type Err = InvalidFileName

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 FileName

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 FileName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for FileName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for FileName

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FileName

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 FileName

impl TryFrom<String> for FileName

type Error = InvalidFileName

The type returned in the event of a conversion error.

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

Performs the conversion.