Skip to main content

Tokens

Struct Tokens 

Source
pub struct Tokens { /* private fields */ }
Expand description

One origin’s declared tokens, in declaration order. Built with the chaining constructors and handed to crate::Core::set_tokens whole; each call replaces the caller’s table.

Implementations§

Source§

impl Tokens

Source

pub fn new() -> Self

Source

pub fn color(self, name: impl Into<String>, c: Color) -> Self

A colour with one value for both bases.

Source

pub fn color_themed( self, name: impl Into<String>, light: Color, dark: Color, ) -> Self

A colour with a value per base.

Source

pub fn color_token(self, name: impl Into<String>, token: ColorToken) -> Self

Source

pub fn derive( self, name: impl Into<String>, from: &str, ops: impl IntoIterator<Item = ColorOp>, ) -> Self

A colour computed from another: from is a colour token already in this table or a theme role, and ops the steps applied to it in order, each colour operand likewise a name declared before this one. A source that resolves to nothing — undeclared, a length, this token itself, or one declared after it — drops the declaration and is reported by Tokens::unresolved; the core raises unknown-token for each when the table is set. An empty chain is an alias.

Source

pub fn length(self, name: impl Into<String>, px: f32) -> Self

A length in logical px, before env.scale.

Source

pub fn id(&self, name: &str) -> Option<TokenRef>

The reference a declared name resolves to in this table alone — what a Rust app holds instead of the name.

Source

pub fn color_id(&self, name: &str) -> Option<TokenRef>

Source

pub fn length_id(&self, name: &str) -> Option<TokenRef>

Source

pub fn colors(&self) -> &[(String, ColorToken)]

The colours, in declaration order.

Source

pub fn lengths(&self) -> &[(String, f32)]

The lengths, in declaration order.

Source

pub fn reserved(&self) -> &[String]

The names a role owns that this declaration tried to take.

Source

pub fn unresolved(&self) -> &[Unresolved]

The derived tokens this declaration dropped, with the source that did not resolve.

Source

pub fn is_empty(&self) -> bool

Source

pub fn resolve_color(&self, i: u16, theme: &Theme) -> Color

The colour token at i under theme: a value’s half, or a derived token’s recipe folded over its source’s — recursing through a derived source, which is always an earlier index. A derived colour comes back rounded to eight bits a channel, so it is exactly what a reader gets through 0xRRGGBBAA.

Source

pub fn halves(&self, i: u16, theme: &Theme) -> (Color, Color)

Both halves of the colour token at i, the light first: a value’s as declared; a derived token’s computed under theme for the half in effect and under a theme of the other appearance with the same accent for the other — what the devtools show beside the swatch.

Source

pub fn recipe(&self, i: u16) -> Option<String>

A derived token’s recipe as the devtools print it — peach → lift 0.3 → alpha 0.5 — or None for a value.

Trait Implementations§

Source§

impl Clone for Tokens

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 Tokens

Source§

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

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

impl Default for Tokens

Source§

fn default() -> Self

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

impl PartialEq for Tokens

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 StructuralPartialEq for Tokens

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.