Skip to main content

Token

Struct Token 

Source
pub struct Token<T> { /* private fields */ }
Expand description

A named value of type T, written as the custom property --<name>.

Token::var reads it as var(--<name>, <default>), so a page without a Theme shows the default. A Theme sets it for the whole page, and Style::token for one element and those inside it.

Two tokens with the same name are one custom property to the browser, and nothing checks that each name is used once.

use hypersig_style::value::{Color, px};
use hypersig_style::{Media, Style, Theme, Token};

let brand = Token::new("brand", Color::hex(0xb83f45));
let button = Style::new().background_color(brand.var()).padding(px(8));
let theme = Theme::new().on(Media::Dark, Theme::new().set(&brand, Color::hex(0xff6b6b)));
assert!(theme.to_css().contains("@media (prefers-color-scheme: dark){:root{--brand:#ff6b6b}}"));

Implementations§

Source§

impl<T: TokenValue> Token<T>

Source

pub fn new(name: &'static str, default: T) -> Self

A token named name whose value is default until something sets it.

§Panics

Panics if name is empty or holds a character other than an ASCII letter, digit, -, or _, which a custom property name would need escaped.

Source

pub fn name(&self) -> &'static str

The name, without the leading --.

Source

pub fn var(&self) -> T

The token’s current value, as var(--<name>, <default>).

Trait Implementations§

Source§

impl<T: Clone> Clone for Token<T>

Source§

fn clone(&self) -> Token<T>

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<T: Debug> Debug for Token<T>

Source§

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

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

impl<T: PartialEq> PartialEq for Token<T>

Source§

fn eq(&self, other: &Token<T>) -> bool

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

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

Inequality operator !=. Read more
Source§

impl<T: PartialEq> StructuralPartialEq for Token<T>

Auto Trait Implementations§

§

impl<T> Freeze for Token<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Token<T>
where T: RefUnwindSafe,

§

impl<T> Send for Token<T>
where T: Send,

§

impl<T> Sync for Token<T>
where T: Sync,

§

impl<T> Unpin for Token<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Token<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Token<T>
where T: UnwindSafe,

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

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

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

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.