Struct TaskId

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

How tasks are referenced throughout projects.

All tasks must have an associated TaskId.

Implementations

impl TaskId

pub fn new<S>(s: S) -> Result<TaskId, InvalidId>

where S: AsRef<str>,

pub fn prop<T>(&self, name: &str) -> Result<Prop<T>, InvalidId>

where T: Clone + Send + Sync + 'static,

Creates a new empty property. Does not register said property

pub fn vec_prop<T>(&self, name: &str) -> Result<VecProp<T>, InvalidId>

where T: Clone + Send + Sync + 'static,

Creates a new vec property. Does not register said property

pub fn project_id(&self) -> Option<ProjectId>

Gets the project id that contains this task.

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 AsRef<TaskId> for TaskId

fn as_ref(&self) -> &TaskId

Converts this type into a shared reference of the (usually inferred) input type.

impl Buildable for TaskId

fn get_dependencies( &self, _project: &Project, ) -> Result<HashSet<TaskId>, PayloadError<ProjectError>>

Gets the dependencies required to build this task

impl Clone for TaskId

fn clone(&self) -> TaskId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TaskId

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

Formats the value using the given formatter.

impl Default for TaskId

fn default() -> TaskId

Returns the “default value” for a type.

impl Deref for TaskId

type Target = Id

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for TaskId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TaskId

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

Formats the value using the given formatter.

impl From<&TaskId> for TaskId

fn from(t: &TaskId) -> TaskId

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<TaskId> for BuildableObject

fn from(c: TaskId) -> BuildableObject

Converts to this type from the input type.

impl From<TaskId> for Origin

fn from(t: TaskId) -> Origin

Converts to this type from the input type.

impl From<TaskId> for TaskPathBuf

fn from(value: TaskId) -> TaskPathBuf

Converts to this type from the input type.

impl FromStr for TaskId

fn from_str(s: &str) -> Result<TaskId, <TaskId 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 Hash for TaskId

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<I> PartialEq<I> for TaskId

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 ==.

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 TaskId

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

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 TryFrom<&str> for TaskId

type Error = InvalidId

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for TaskId

type Error = InvalidId

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<TaskId, <TaskId as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for TaskId

impl StructuralPartialEq for TaskId