Struct Id

pub struct Id { /* private fields */ }

Represents some identifier in an assemble project.

Acts like a path. Consists for two parts, the this part and the parent. For example, in root:inner:task, the this is task and the parent is root:inner.

Implementations

impl Id

pub fn new<S>(val: S) -> Result<Id, InvalidId>

where S: AsRef<str>,

Create a new id. The leading : is optional.

Error

Errors if it isn’t a valid identifier.

Example

let id = Id::new("root:inner:task").unwrap();
assert!(Id::new("&task").is_err());
assert!(Id::new("2132").is_err());
assert!(Id::new("gef::as").is_err());
assert_eq!(Id::new(":root"), Id::new("root"));

pub fn from_iter<S>(iter: impl IntoIterator<Item = S>) -> Result<Id, InvalidId>

where S: AsRef<str>,

Try to create an Id from an iterator of parts. Each part must be a valid part of an identifier.

Example

assert!(Id::from_iter(["root", "task"]).is_ok());
assert!(Id::from_iter(["root:inner", "task"]).is_err());
assert!(Id::from_iter(["root", "inner", "task"]).is_ok());

pub fn join<S>(&self, next: S) -> Result<Id, InvalidId>

where S: AsRef<str>,

Joins something that can be turned into an identifier to the end of this Id.

Error

Errors if the next is not a valid identifier

pub fn concat<I>(&self, other: I) -> Id

where I: Into<Id>,

Concatenate two Id’s together

pub fn this(&self) -> &str

Returns this part of an identifier path.

pub fn this_id(&self) -> Id

Returns this part of an identifier path as an Id

pub fn parent(&self) -> Option<&Id>

Returns the parent identifier of this id, if it exists.

pub fn is_shorthand(&self, repr: &str) -> bool

Check if the given representation is a valid shorthand.

pub fn is_shorthand_this(&self, repr: &str) -> bool

pub fn ancestors(&self) -> impl Iterator<Item = &Id>

Gets the ancestors of this id.

For example, the ancestors of root:inner:task would be

• root:inner:task
• root:inner
• root

pub fn iter(&self) -> Iter<'_>

pub fn as_path(&self) -> PathBuf

Trait Implementations

impl Clone for Id

fn clone(&self) -> Id

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Id

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

Formats the value using the given formatter.

impl Default for Id

fn default() -> Id

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Id

fn deserialize<D>( deserializer: D, ) -> Result<Id, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Id

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

Formats the value using the given formatter.

impl From<&str> for Id

fn from(id: &str) -> Id

Converts to this type from the input type.

impl From<Id> for ProjectId

fn from(id: Id) -> ProjectId

Converts to this type from the input type.

impl From<Id> for TaskId

fn from(i: Id) -> TaskId

Converts to this type from the input type.

impl From<ProjectId> for Id

fn from(id: ProjectId) -> Id

Converts to this type from the input type.

impl Hash for Id

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

where __H: Hasher,

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<&Id> for Id

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

fn eq(&self, other: &Id) -> 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<S> PartialEq<S> for Id

where S: AsRef<str> + ?Sized,

fn eq(&self, other: &S) -> 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 PartialEq<str> for &Id

fn eq(&self, other: &str) -> 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 PartialEq for Id

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

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Id

impl StructuralPartialEq for Id