Struct Doc 

pub struct Doc { /* private fields */ }

A view with ids assigned: the tree of each region, as last sent.

Implementations

impl Doc

pub fn new() -> Self

The empty view.

pub fn from_view<M>(view: View<M>) -> Result<Self, Error>

Reconciles a view’s tree (handlers are dropped).

Errors

Error::DuplicateId when two siblings share an id.

pub fn from_json(value: &Value) -> Result<Self, Error>

Builds a view from its wire form {main?, dock?, layer?} of nodes {k, p?, c?} (null is the empty view). Region roots must be nodes, not lists; use View builders for implicit col wrapping.

Missing or null p and c mean no props or children. An empty object c also means no children (an empty Luau table). Other p values must be objects and other c values must be lists. Errors include the node path; duplicate-key errors also name the key.

Errors

Error::InvalidView for a malformed view, Error::DuplicateId when two siblings share an id.

pub const fn regions(&self) -> &[Option<Tree>; 3]

The region trees in order main, dock, layer.

pub fn ops(&self, next: &Self, surface: &str) -> Vec<Op>

The ops turning this view into next on surface surface.

Trait Implementations

impl Clone for Doc

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Doc

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

Formats the value using the given formatter.

impl Default for Doc

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Doc

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Doc