Struct biscuit_wasm::Biscuit

pub struct Biscuit(_);

a Biscuit token

it can produce an attenuated or sealed token, or be used in an authorizer along with Datalog policies

Implementations

impl Biscuit

pub fn builder() -> BiscuitBuilder

Creates a BiscuitBuilder

the builder can then create a new token with a root key

pub fn create_block(&self) -> BlockBuilder

Creates a BlockBuilder to prepare for attenuation

the bulder can then be given to the token’s append method to create an attenuated token

pub fn append(&self, block: BlockBuilder) -> Result<Biscuit, JsValue>

Creates an attenuated token by adding the block generated by the BlockBuilder

pub fn authorizer(&self) -> Result<Authorizer, JsValue>

Creates an authorizer from the token

pub fn seal(&self) -> Result<Biscuit, JsValue>

Seals the token

A sealed token cannot be attenuated

pub fn from_bytes(data: &[u8], root: &PublicKey) -> Result<Biscuit, JsValue>

Deserializes a token from raw data

This will check the signature using the root key

pub fn from_base64(data: &str, root: &PublicKey) -> Result<Biscuit, JsValue>

Deserializes a token from URL safe base 64 data

This will check the signature using the root key

pub fn to_bytes(&self) -> Result<Box<[u8]>, JsValue>

Serializes to raw data

pub fn to_base64(&self) -> Result<String, JsValue>

Serializes to URL safe base 64 data

pub fn revocation_identifiers(&self) -> Box<[JsValue]>

Returns the list of revocation identifiers, encoded as URL safe base 64

pub fn block_count(&self) -> usize

Returns the number of blocks in the token

pub fn block_source(&self, index: usize) -> Option<String>

Prints a block’s content as Datalog code

Trait Implementations

impl From<Biscuit> for JsValue

fn from(value: Biscuit) -> Self

Converts to this type from the input type.

impl FromWasmAbi for Biscuit

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for Biscuit

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for Biscuit

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Biscuit

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Biscuit

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, Biscuit>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Biscuit

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, Biscuit>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl WasmDescribe for Biscuit

fn describe()