Struct ProjectDoc 

pub struct ProjectDoc { /* private fields */ }

Represents an entire sb3 program file with all Targets, blocks (TargetBlocks) and procedures (TargetProcedures)

See the crate level docs for a general explaination

Implementations

impl ProjectDoc

pub fn from_json<'a>(doc: &'a Value) -> Result<ProjectDoc, ModelError<'a>>

Parses a document from a json value

impl ProjectDoc

Auto-generated by derive_getters::Getters.

pub fn targets(&self) -> &ARc<[Target]>

Targets of the document, see Target for details

pub fn semver(&self) -> &Option<ARc<str>>

The version number stored as metadata in the document

This field is currently unused by the implementation but may be used in the future to detect compatible files

impl ProjectDoc

pub fn ids_with_opcodes(&self) -> impl Iterator<Item = (&Id, BlockKindUnit)>

pub fn su_ids_with_blocks(&self) -> impl Iterator<Item = (&Id, BlockKindUnit)>

pub fn get_block<'a>( &'a self, id: &Id, ) -> Result<&'a ARc<BlockWrapper>, NoValidBlockForId>

Returns the block with the given Id regardless in which target it’s stored.

pub fn get_specific_kind<T: WrappableKind + PartialEq>( &self, reference: &RefBlock<T>, ) -> Result<&T, BlockReferenceInvalid>

pub fn get_specific_with_wrapper<T: WrappableKind>( &self, reference: &RefBlock<T>, ) -> Result<(&T, &ARc<BlockWrapper>), BlockReferenceInvalid>

Trait Implementations

impl Clone for ProjectDoc

fn clone(&self) -> ProjectDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectDoc

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

Formats the value using the given formatter.

impl PartialEq for ProjectDoc

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProjectDoc