assemble_std::identifier

Struct ProjectId

pub struct ProjectId(/* private fields */);

Expand description

How projects are referenced. Unlike tasks, projects don’t have to have parents.

Implementations§

impl ProjectId

pub fn root() -> ProjectId

pub fn from_path(path: impl AsRef<Path>) -> Result<ProjectId, InvalidId>

pub fn new(id: &str) -> Result<ProjectId, InvalidId>

Methods from Deref<Target = Id>§

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 ProjectId

fn clone(&self) -> ProjectId

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for ProjectId

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

Formats the value using the given formatter. Read more

impl Default for ProjectId

fn default() -> ProjectId

Returns the “default value” for a type. Read more

impl Deref for ProjectId

type Target = Id

The resulting type after dereferencing.

fn deref(&self) -> &<ProjectId as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for ProjectId

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

Deserialize this value from the given Serde deserializer. Read more

impl Display for ProjectId

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

Formats the value using the given formatter. Read more

impl From<&ProjectId> for ProjectId

fn from(value: &ProjectId) -> ProjectId

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

fn from(id: ProjectId) -> Id

Converts to this type from the input type.

impl From<ProjectId> for Origin

fn from(p: ProjectId) -> Origin

Converts to this type from the input type.

impl From<ProjectId> for ProjectPathBuf

fn from(value: ProjectId) -> ProjectPathBuf

Converts to this type from the input type.

impl FromStr for ProjectId

fn from_str(s: &str) -> Result<ProjectId, <ProjectId as FromStr>::Err>

Parses a task ID. Unlike the TryFrom methods, this one can produced multi level ids

type Err = InvalidId

The associated error which can be returned from parsing.

impl GetProjectId for ProjectId

fn project_id(&self) -> ProjectId

fn parent_id(&self) -> Option<ProjectId>

fn root_id(&self) -> ProjectId

fn is_root(&self) -> bool

Get whether this project is a root

impl Hash for ProjectId

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

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

impl<I> PartialEq<I> for ProjectId
where Id: PartialEq<I>, I: ?Sized,

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

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

1.0.0 · 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.

impl PartialEq for ProjectId

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

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

1.0.0 · 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.

impl Serialize for ProjectId

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. Read more

impl TryFrom<&Path> for ProjectId

type Error = InvalidId

The type returned in the event of a conversion error.

fn try_from( value: &Path, ) -> Result<ProjectId, <ProjectId as TryFrom<&Path>>::Error>

Performs the conversion.

impl TryFrom<&str> for ProjectId

type Error = InvalidId

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<ProjectId, <ProjectId as TryFrom<&str>>::Error>

Performs the conversion.

impl Eq for ProjectId

impl StructuralPartialEq for ProjectId

Auto Trait Implementations§

impl Freeze for ProjectId

impl RefUnwindSafe for ProjectId

impl Send for ProjectId

impl Sync for ProjectId

impl Unpin for ProjectId

impl UnwindSafe for ProjectId

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn instance_of<T>(&self) -> bool
where T: Any + ?Sized,

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> IntoNamed for T

fn named<S>(self, name: S) -> Named<Self>
where S: AsRef<str>,

Add a name to this object

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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

impl<T> ErasedDestructor for T
where T: 'static,

impl<E> Extension for E
where E: 'static + Send + Sync,

impl<T> MaybeSendSync for T