Enum PathKind 

pub enum PathKind {
    SetExists(PathBuf),
    SetAbsent(PathBuf),
    NotSet(usize),
}

Represents the presence or absence of a path.

Variants

SetExists(PathBuf)

A PathBuf that has been defined and points to a real buffer.

SetAbsent(PathBuf)

A PathBuf that has been defined but isn’t a real buffer.

NotSet(usize)

A PathBuf that has not been defined.

The number within represents a specific Buffer, and when printed to, for example, the StatusLine, would show up as txt!("[buffer]*scratch buffer*#{id}")

Implementations

impl PathKind

pub fn as_path(&self) -> Option<PathBuf>

Returns a PathBuf if self is SetExists or SetAbsent.

pub fn path(&self) -> String

The full path of the buffer.

If there is no set path, returns "*scratch buffer*#{id}".

pub fn path_set(&self) -> Option<String>

The full path of the buffer.

Returns None if the path has not been set yet.

pub fn name(&self) -> String

The buffer’s name.

If there is no set path, returns "*scratch buffer #{id}*".

pub fn name_set(&self) -> Option<String>

The buffer’s name.

Returns None if the path has not been set yet.

pub fn path_txt(&self) -> Text

A Text from the full path of this PathKind.

Formatting

If the buffer’s path was set:

[buffer]{path}

If the buffer’s path was not set:

[buffer.new.scratch]*scratch buffer #{id}*

pub fn name_txt(&self) -> Text

A Text from the name of this PathKind.

The name of a Buffer widget is the same as the path, but it strips away the current directory. If it can’t, it will try to strip away the home directory, replacing it with "~". If that also fails, it will just show the full path.

Formatting

If the buffer’s name was set:

[buffer]{name}

If the buffer’s name was not set:

[buffer.new.scratch]*scratch buffer #{id}*

Trait Implementations

impl AsBuilderPart for PathKind

fn as_builder_part(&self) -> BuilderPart<'_>

Gets a BuilderPart fro this value

impl Clone for PathKind

fn clone(&self) -> PathKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathKind

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

Formats the value using the given formatter.

impl<P: AsRef<Path>> From<P> for PathKind

fn from(value: P) -> Self

Converts to this type from the input type.

impl Hash for PathKind

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 Ord for PathKind

fn cmp(&self, other: &PathKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PathKind

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PathKind

fn partial_cmp(&self, other: &PathKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for PathKind

impl StructuralPartialEq for PathKind