Skip to main content

StorageBookmarkHelper

ferroui_base::platform::storage::file_io

Struct StorageBookmarkHelper 

Source 
pub struct StorageBookmarkHelper;
Expand description

In order to have unique bookmarks across platforms, we prepend a platform specific suffix before native bookmark. And always encoding them in base64 before returning to the user.

Bookmarks are encoded as: 0-6 - framework prefix with version number 7-15 - platform key 16+ - native bookmark value Which is then encoded in Base64.

This is an implementation detail of the platform backends.

Implementations§

Source§

impl StorageBookmarkHelper

Source

pub fn encode_bookmark( platform: &[u8], native_bookmark: Option<&str>, ) -> Option<String>

Encodes the text of a native bookmark of the given platform; None for no bookmark and for an empty one.

§Panics

See encode_bookmark_bytes.

Source

pub fn encode_bookmark_bytes( platform: &[u8], native_bookmark_bytes: &[u8], ) -> Option<String>

Encodes a native bookmark of the given platform; None for an empty one.

§Panics

Panics when the platform name is longer than the header, or does not fit in the encoded bookmark.

Source

pub fn try_decode_bookmark( platform: &[u8], base64_bookmark: Option<&str>, ) -> (DecodeResult, Option<Vec<u8>>)

Decodes a bookmark of the given platform into its native bookmark. The native bookmark is Some exactly when the result is DecodeResult::Success.

Source

pub fn encode_bcl_bookmark(local_path: &str) -> String

Encodes the local path of a file-system backed storage item as a bookmark.

§Panics

Panics when the path is empty.

Source

pub fn try_decode_bcl_bookmark(native_bookmark: &str) -> Option<String>

Decodes the bookmark of a file-system backed storage item into its local path. Bookmarks of the format used before bookmarks were encoded (plain paths) are accepted too.

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> ClassDefaults for T
where T: ?Sized,

Source§

fn static_constructor()

The static constructor of a type: work done once per thread, after the properties of the type are registered and before its first instance exists (class handlers, affects_render, metadata overrides). 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, 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.