Skip to main content

Spec

Enum Spec 

Source
#[non_exhaustive]
pub enum Spec { Device(PathBuf), Label(String), Uuid(String), PartLabel(String), PartUuid(String), Id(String), NetworkMount { host: String, path: PathBuf, }, Keyword(String), }
Expand description

Filesystem source identifier — fstab(5) field 1.

Corresponds to libmount: fs->source + fs->tagname/fs->tagval.

§Examples

let spec = Spec::parse("UUID=abc-123").unwrap();
assert!(matches!(spec, Spec::Uuid(_)));
assert!(spec.is_tag());

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Device(PathBuf)

Block device path: /dev/sda1, /dev/disk/by-uuid/...

§

Label(String)

Filesystem label: LABEL=Boot

§

Uuid(String)

Filesystem UUID: UUID=3e6be9de-... (preserves original case)

§

PartLabel(String)

GPT partition label: PARTLABEL=System

§

PartUuid(String)

GPT partition UUID: PARTUUID=...

§

Id(String)

👎Deprecated:

ID= tag is not strictly defined and depends on udev rules/hardware

Hardware block device ID (deprecated, per fstab(5) and mount(8)).

The ID= tag is not strictly defined and depends on udev rules or hardware topology. Prefer UUID=, PARTUUID=, or /dev/disk/by-* paths instead.

§

NetworkMount

NFS-style network mount: host:/path

Fields

§host: String

Remote host (hostname, IP address, or bracketed IPv6 address).

§path: PathBuf

Exported path on the remote host.

§

Keyword(String)

Pseudo-filesystem keyword: proc, tmpfs, sysfs, none, etc.

Implementations§

Source§

impl Spec

Source

pub fn parse(raw: &str) -> Result<Self, SpecError>

Parse a decoded spec string into a typed Spec.

This function accepts already-decoded strings. If you need to parse escape-encoded strings from an fstab file, use parse_raw instead (crate-internal helper that calls decode_escapes before parsing).

§Examples
// Device path
let spec = Spec::parse("/dev/sda1").unwrap();
assert!(matches!(spec, Spec::Device(_)));

// Tag-based identifier (case-insensitive tag prefix)
let spec = Spec::parse("uuid=abc-123").unwrap();
assert_eq!(spec, Spec::Uuid("abc-123".into()));

// Label
let spec = Spec::parse("LABEL=Boot").unwrap();
assert_eq!(spec, Spec::Label("Boot".into()));

// NFS network mount
let spec = Spec::parse("server:/export").unwrap();
assert!(matches!(spec, Spec::NetworkMount { .. }));

// Pseudo-filesystem
let spec = Spec::parse("proc").unwrap();
assert!(spec.is_pseudo());
§Errors

Returns SpecError::Empty if the input is empty.

Source

pub fn is_tag(&self) -> bool

Returns true if this is a tag-based identifier (LABEL/UUID/PARTLABEL/PARTUUID/ID).

Source

pub fn is_pseudo(&self) -> bool

Returns true if this is a pseudo-filesystem (no backing block device).

Source

pub fn tag_name(&self) -> Option<&'static str>

Returns the tag prefix name for tag-based identifiers.

Returns Some("LABEL"), Some("UUID"), Some("PARTLABEL"), Some("PARTUUID"), or Some("ID") for tag variants, or None for non-tag variants.

§Examples
let spec = Spec::parse("UUID=abc-123").unwrap();
assert_eq!(spec.tag_name(), Some("UUID"));
assert_eq!(Spec::parse("/dev/sda1").unwrap().tag_name(), None);
Source

pub fn tag_value(&self) -> Option<&str>

Returns the tag value for tag-based identifiers.

Returns Some(value) for tag variants (e.g., "abc-123" for UUID=abc-123), or None for non-tag variants.

§Examples
let spec = Spec::parse("LABEL=Boot").unwrap();
assert_eq!(spec.tag_value(), Some("Boot"));
assert_eq!(Spec::parse("proc").unwrap().tag_value(), None);

Trait Implementations§

Source§

impl Clone for Spec

Source§

fn clone(&self) -> Spec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Spec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Spec

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Spec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromStr for Spec

Source§

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

Parse a string into a Spec.

This is equivalent to Spec::parse.

Source§

type Err = SpecError

The associated error which can be returned from parsing.
Source§

impl Hash for Spec

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Spec

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for Spec

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<&str> for Spec

Try to convert a string into a Spec.

Equivalent to Spec::parse.

Source§

type Error = SpecError

The type returned in the event of a conversion error.
Source§

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl Eq for Spec

Source§

impl StructuralPartialEq for Spec

Auto Trait Implementations§

§

impl Freeze for Spec

§

impl RefUnwindSafe for Spec

§

impl Send for Spec

§

impl Sync for Spec

§

impl Unpin for Spec

§

impl UnsafeUnpin for Spec

§

impl UnwindSafe for Spec

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,