Skip to main content

TimeEntryExtensions

Struct TimeEntryExtensions 

Source
pub struct TimeEntryExtensions(/* private fields */);
Expand description

Unknown metadata carried by one TimeEntry, preserved verbatim.

The rule this exists for (C-007, T005): a key a newer tix adds must survive an edit-and-save round trip instead of being dropped. Values are held as parsed YAML values rather than strings so a sequence, a mapping or a number written by another build is preserved as what it is, not rejected for not being a string. A BTreeMap keeps the render order deterministic, so a file that did not change does not gain a diff.

Equality is by canonical render rather than by the derived comparison, because serde_yaml::Value is not Eq (floats are not), while an entry — and therefore the Issue that holds a list of them — must stay Eq. Two extension maps are equal exactly when they render identically, which is also what round-trip stability means here.

Implementations§

Source§

impl TimeEntryExtensions

Source

pub fn is_empty(&self) -> bool

Whether no unknown metadata is present.

Source

pub fn len(&self) -> usize

The number of preserved keys.

Source

pub fn get(&self, key: &str) -> Option<&Value>

Look up a preserved key.

Source

pub fn keys(&self) -> impl Iterator<Item = &str>

The preserved keys, in canonical (sorted) order.

Source

pub fn iter(&self) -> impl Iterator<Item = (&str, &Value)>

Iterate the preserved (key, value) pairs in canonical order.

Source

pub fn as_map(&self) -> &BTreeMap<String, Value>

The underlying map, for a caller that must serialize or splice it whole.

Source

pub fn insert(&mut self, key: impl Into<String>, value: Value) -> Option<Value>

Preserve one (key, value) pair, returning the previous value if any.

Source

pub fn canonical_yaml(&self) -> String

The canonical YAML render, used for equality and for the tie-break of TimeEntry’s ordering.

Trait Implementations§

Source§

impl Clone for TimeEntryExtensions

Source§

fn clone(&self) -> Self

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 TimeEntryExtensions

Source§

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

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

impl Default for TimeEntryExtensions

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for TimeEntryExtensions

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 Eq for TimeEntryExtensions

Source§

impl From<BTreeMap<String, Value>> for TimeEntryExtensions

Source§

fn from(map: BTreeMap<String, Value>) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for TimeEntryExtensions

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for TimeEntryExtensions

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

Auto Trait Implementations§

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

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

Compare self to key and return true if they are equal.
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> IntoEither for T

Source§

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
Source§

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
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.