Struct Place 

#[non_exhaustive]
pub struct Place {
    pub label: String,
    pub path: PathBuf,
    pub origin: PlaceOrigin,
    pub separator_thickness: Option<u32>,
}

A single place entry shown in the left “Places” pane.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

label: String

Display name shown in UI.

path: PathBuf

Target directory path.

origin: PlaceOrigin

Origin of the entry (user vs code).

separator_thickness: Option<u32>

Optional UI separator thickness (in pixels).

When set, this item is treated as a non-interactive separator instead of a navigable place.

Implementations

impl Place

pub fn new(label: impl Into<String>, path: PathBuf, origin: PlaceOrigin) -> Self

Creates a new place entry.

pub fn user(label: impl Into<String>, path: PathBuf) -> Self

Convenience constructor for a user-defined place.

pub fn code(label: impl Into<String>, path: PathBuf) -> Self

Convenience constructor for a code-defined place.

pub fn separator(thickness: u32) -> Self

Creates a non-interactive separator row.

pub fn is_separator(&self) -> bool

Returns whether this item is a separator row.

Trait Implementations

impl Clone for Place

fn clone(&self) -> Place

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Place

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

Formats the value using the given formatter.

impl PartialEq for Place

fn eq(&self, other: &Place) -> 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 Eq for Place

impl StructuralPartialEq for Place