Skip to main content

Capabilities

Struct Capabilities 

Source
pub struct Capabilities {
Show 20 fields pub bold: bool, pub italic: bool, pub code: bool, pub mark: bool, pub underline: bool, pub strike: bool, pub superscript: bool, pub subscript: bool, pub heading: bool, pub blockquote: bool, pub bullet_list: bool, pub ordered_list: bool, pub task: bool, pub link: bool, pub image: bool, pub thematic_break: bool, pub footnote: bool, pub code_language: bool, pub table: bool, pub cell_line_break: bool,
}
Expand description

Which formatting controls this document’s format can spell — the toolbar’s enabled state, one flag per button, from LeafDoc::capabilities. Mirrors leaf_core::Capabilities, where the reasoning lives.

Its shape is a flat record of Bools rather than a query taking a gesture because the Swift side wants exactly one crossing and a value it can hold in an @Observable: let caps = doc.capabilities(), then .disabled(!caps.bold) on each control.

Fields§

§bold: bool§italic: bool§code: bool§mark: bool§underline: bool§strike: bool§superscript: bool§subscript: bool§heading: bool

Both LeafDoc::set_heading and LeafDoc::set_paragraph — they are the same gesture in core and stand or fall together.

§blockquote: bool§bullet_list: bool§ordered_list: bool§task: bool

LeafDoc::toggle_task_item, LeafDoc::toggle_task_checked and LeafDoc::toggle_task_at — including a tap on a rendered checkbox, which should not be live where the box cannot be spelled.

§link: bool§image: bool

[LeafDoc::insert_image] and LeafDoc::insert_media both.

§thematic_break: bool§footnote: bool

LeafDoc::insert_footnote. Markdown and djot spell the pair; HTML does not, so the button goes rather than dims into a refusal.

§code_language: bool§table: bool

The grid controls. Gate them on this and LeafDoc::caret_in_table: this asks whether the format’s tables are editable, that whether the caret is in one.

§cell_line_break: bool

Shift+Return inside a cell — LeafDoc::cell_line_break.

Trait Implementations§

Source§

impl<UT> ConvertError<UT> for Capabilities

Source§

impl<UT> FfiConverter<UT> for Capabilities

Source§

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.
Source§

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI. Read more
Source§

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType. Read more
Source§

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType. Read more
Source§

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form. Read more
Source§

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form. Read more
Source§

impl From<Capabilities> for Capabilities

Source§

fn from(c: CoreCapabilities) -> Self

Converts to this type from the input type.
Source§

impl<UT> Lift<UT> for Capabilities

Source§

type FfiType = <Capabilities as FfiConverter<UT>>::FfiType

Source§

fn try_lift(v: Self::FfiType) -> Result<Self>

Source§

fn try_read(buf: &mut &[u8]) -> Result<Self>

Source§

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method
Source§

impl<UT> LiftRef<UT> for Capabilities

Source§

impl<UT> LiftReturn<UT> for Capabilities

Source§

type ReturnType = <Capabilities as Lift<UT>>::FfiType

FFI return type for trait interfaces
Source§

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface
Source§

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface Read more
Source§

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result Read more
Source§

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error Read more
Source§

impl<UT> Lower<UT> for Capabilities

Source§

type FfiType = <Capabilities as FfiConverter<UT>>::FfiType

Source§

fn lower(obj: Self) -> Self::FfiType

Source§

fn write(obj: Self, buf: &mut Vec<u8>)

Source§

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method
Source§

impl<UT> LowerError<UT> for Capabilities

Source§

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return Read more
Source§

impl<UT> LowerReturn<UT> for Capabilities

Source§

type ReturnType = <Capabilities as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type. Read more
Source§

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call Read more
Source§

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts Read more
Source§

impl<UT> TypeId<UT> for Capabilities

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

Source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
Source§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
Source§

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more
Source§

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
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 = 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.