Struct Node 

pub struct Node {
    pub kind: KindT,
    pub params: Option<NodeParams>,
    pub children: Option<Vec<Node>>,
}

Node

This is the core data structure for generating MSVJ files. Each node type can have a type, params, and children.

Methods derived from the Python API found here

Fields

kind: KindT

params: Option<NodeParams>

children: Option<Vec<Node>>

Implementations

impl Node

pub fn new(kind: KindT, params: Option<NodeParams>) -> Node

pub fn add_child(&mut self, node: Node)

pub fn get_kind(&self) -> &KindT

pub fn download(&mut self, url: &str) -> Option<&mut Node>

Create the download node

pub fn parse(&mut self, params: ParseParams) -> Option<&mut Node>

Parse a Download Node

pub fn model_structure(&mut self, params: StructureParams) -> Option<&mut Node>

Create a structure for the deposited (asymmetric unit / model) coordinates.

pub fn assembly_structure( &mut self, params: StructureParams, ) -> Option<&mut Node>

Parse a Download Node

pub fn symmetry_structure( &mut self, params: StructureParams, ) -> Option<&mut Node>

Symmetry Structure

pub fn symmetry_mates_structure( &mut self, params: StructureParams, ) -> Option<&mut Node>

Parse a Download Node

pub fn volume(&mut self, params: VolumeParams) -> Option<&mut Node>

Create a Volume node (parallel to a Structure node — loads volumetric data).

pub fn volume_representation( &mut self, params: VolumeRepresentationParams, ) -> Option<&mut Node>

Add an isosurface or grid-slice representation for this volume.

pub fn component(&mut self, selector: ComponentSelector) -> Option<&mut Node>

Create a Component

pub fn component_from_uri( &mut self, params: ComponentFromUriParams, ) -> Option<&mut Node>

pub fn component_from_source( &mut self, params: ComponentFromSourceParams, ) -> Option<&mut Node>

pub fn label_from_uri( &mut self, params: LabelFromUriParams, ) -> Option<&mut Node>

Add labels loaded from an external annotation file.

pub fn label_from_source( &mut self, params: LabelFromSourceParams, ) -> Option<&mut Node>

Add labels read from a category of the structure’s own source file.

pub fn tooltip_from_uri( &mut self, params: TooltipFromUriParams, ) -> Option<&mut Node>

Add tooltips loaded from an external annotation file.

pub fn tooltip_from_source( &mut self, params: TooltipFromSourceParams, ) -> Option<&mut Node>

Add tooltips read from a category of the structure’s own source file.

pub fn transform(&mut self, params: TransformParams) -> Option<&mut Node>

Add a transform to a structure.

Returns None if self is not a structure, or if params.rotation is non-empty and not a 3x3 rotation matrix (see is_rotation_matrix); the Python builder raises ValueError in that case.

pub fn representation( &mut self, representation_type: RepresentationTypeT, ) -> Option<&mut Node>

Add a representation for this component. :param type: the type of representation, defaults to ‘cartoon’ :return: a builder that handles operations at representation level

pub fn representation_with_theme( &mut self, representation_type: RepresentationTypeT, color_theme: Option<ColorThemeT>, ) -> Option<&mut Node>

pub fn label(&mut self, label: String) -> Option<&mut Node>

pub fn tooltip(&mut self, text: String) -> Option<&mut Node>

pub fn focus( &mut self, direction: Option<(f64, f64, f64)>, up: Option<(f64, f64, f64)>, ) -> Option<&mut Node>

pub fn color_from_source( &mut self, params: ColorFromSourceParams, ) -> Option<&mut Node>

pub fn color_from_uri( &mut self, params: ColorFromUriParams, ) -> Option<&mut Node>

pub fn color( &mut self, color: ColorT, selector: ComponentSelector, ) -> Option<&mut Node>

pub fn sphere(&mut self, params: SphereParams) -> Option<&mut Node>

pub fn line(&mut self, params: LineParams) -> Option<&mut Node>

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl Default for Node

fn default() -> Node

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Node

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Serialize for Node

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

where __S: Serializer,

Serialize this value into the given Serde serializer.