Struct CanvasDocument 

pub struct CanvasDocument { /* private fields */ }

Implementations

impl CanvasDocument

pub fn new() -> Self

pub fn builder() -> CanvasDocumentBuilder

pub fn format_version(&self) -> u32

pub fn metadata(&self) -> &CanvasValue

pub fn relations(&self) -> &CanvasRecordRelations

pub fn node(&self, id: &NodeId) -> Option<&CanvasNode>

pub fn edge(&self, id: &EdgeId) -> Option<&CanvasEdge>

pub fn shape(&self, id: &ShapeId) -> Option<&CanvasShape>

pub fn contains_node(&self, id: &NodeId) -> bool

pub fn contains_edge(&self, id: &EdgeId) -> bool

pub fn contains_shape(&self, id: &ShapeId) -> bool

pub fn contains_record(&self, id: &CanvasRecordId) -> bool

pub fn nodes(&self) -> impl Iterator<Item = &CanvasNode> + '_

pub fn edges(&self) -> impl Iterator<Item = &CanvasEdge> + '_

pub fn shapes(&self) -> impl Iterator<Item = &CanvasShape> + '_

pub fn node_entries(&self) -> impl Iterator<Item = (&NodeId, &CanvasNode)> + '_

pub fn edge_entries(&self) -> impl Iterator<Item = (&EdgeId, &CanvasEdge)> + '_

pub fn shape_entries( &self, ) -> impl Iterator<Item = (&ShapeId, &CanvasShape)> + '_

pub fn node_ids(&self) -> impl Iterator<Item = &NodeId> + '_

pub fn edge_ids(&self) -> impl Iterator<Item = &EdgeId> + '_

pub fn shape_ids(&self) -> impl Iterator<Item = &ShapeId> + '_

pub fn node_count(&self) -> usize

pub fn edge_count(&self) -> usize

pub fn shape_count(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn from_snapshot(snapshot: CanvasSnapshot) -> Result<Self, DocumentError>

pub fn from_snapshot_with_kind_registry( snapshot: CanvasSnapshot, kind_registry: &CanvasKindRegistry, ) -> Result<Self, DocumentError>

pub fn to_snapshot(&self) -> CanvasSnapshot

pub fn apply_transaction( &mut self, transaction: CanvasTransaction, ) -> Result<(), DocumentError>

pub fn apply_transaction_with_diff( &mut self, transaction: CanvasTransaction, ) -> Result<CanvasDocumentDiff, DocumentError>

pub fn commit_transaction( &mut self, transaction: CanvasTransaction, ) -> Result<CanvasCommittedMutation, DocumentError>

pub fn commit_transaction_with_kind_registry( &mut self, transaction: CanvasTransaction, kind_registry: &CanvasKindRegistry, ) -> Result<CanvasCommittedMutation, DocumentError>

pub fn invert_transaction( &self, transaction: &CanvasTransaction, ) -> Result<CanvasTransaction, DocumentError>

pub fn validate_endpoint( &self, endpoint: &CanvasEndpoint, ) -> Result<(), DocumentError>

pub fn validate_edge(&self, edge: &CanvasEdge) -> Result<(), DocumentError>

pub fn validate_integrity(&self) -> Result<(), DocumentError>

pub fn endpoint_position( &self, endpoint: &CanvasEndpoint, ) -> Result<Point<Pixels>, DocumentError>

pub fn edge_route_path( &self, edge: &CanvasEdge, ) -> Result<CanvasRoutePath, DocumentError>

pub fn edge_route_path_with_router<R>( &self, edge: &CanvasEdge, router: &R, ) -> Result<CanvasRoutePath, DocumentError>

where R: CanvasEdgeRouter + ?Sized,

pub fn edge_bounds( &self, edge: &CanvasEdge, ) -> Result<Bounds<Pixels>, DocumentError>

pub fn edge_bounds_with_router<R>( &self, edge: &CanvasEdge, router: &R, ) -> Result<Bounds<Pixels>, DocumentError>

where R: CanvasEdgeRouter + ?Sized,

pub fn edge_route_points( &self, edge: &CanvasEdge, ) -> Result<Vec<Point<Pixels>>, DocumentError>

pub fn diff_against(&self, previous: &CanvasDocument) -> CanvasDocumentDiff

pub fn validate_relations(&self) -> Result<(), DocumentError>

impl CanvasDocument

pub fn graph(&self) -> CanvasGraph<'_>

pub fn graph_index(&self) -> CanvasGraphIndex

Trait Implementations

impl Clone for CanvasDocument

fn clone(&self) -> CanvasDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanvasDocument

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

Formats the value using the given formatter.

impl Default for CanvasDocument

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CanvasDocument

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CanvasDocument> for CanvasSnapshot

fn from(value: &CanvasDocument) -> Self

Converts to this type from the input type.

impl PartialEq for CanvasDocument

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CanvasDocument

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CanvasDocument

impl TryFrom<&CanvasDocument> for JsonCanvas

type Error = JsonCanvasError

The type returned in the event of a conversion error.

fn try_from(document: &CanvasDocument) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<CanvasSnapshot> for CanvasDocument

type Error = DocumentError

The type returned in the event of a conversion error.

fn try_from(value: CanvasSnapshot) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<JsonCanvas> for CanvasDocument

type Error = JsonCanvasError

The type returned in the event of a conversion error.

fn try_from(canvas: JsonCanvas) -> Result<Self, Self::Error>

Performs the conversion.