Struct drmem_api::types::device::Name

pub struct Name { /* private fields */ }

Holds a validated device name. A device name consists of a path and a base name where each portion of the path is separated with a colon. Each segment of the path or the name is composed of alpha- numeric and the dash characters. The dash cannot be the first or last character, however.

More formally:

DEVICE-NAME = PATH NAME
PATH = (SEGMENT ':')+
NAME = SEGMENT
SEGMENT = [0-9a-zA-Z] ( [0-9a-zA-Z-]* [0-9a-zA-Z] )?

All device names will have a path and a name. Although superficially similar, device names are not like file system names. Specifically, there’s no concept of moving up or down paths. The paths provide a naming convention to organize devices. The client API supports looking up device names using patterns, so a logical path hierarchy can make those searches more productive.

Implementations

impl Name

pub fn create(s: &str) -> Result<Name>

Creates an instance of Name, if the provided string describes a well-formed device name.

pub fn build(path: Path, base: Base) -> Name

pub fn get_path(&self) -> Path

Returns the path of the device name without the trailing ‘:’.

pub fn get_name(&self) -> Base

Returns the base name of the device.

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl Display for Name

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

Formats the value using the given formatter.

impl FromStr for Name

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for Name

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<Name> for Name

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Name

impl StructuralEq for Name

impl StructuralPartialEq for Name