Struct ring_api::settings::Settings

pub struct Settings {
    pub chain: Chain,
    pub network_policy: NetworkPolicy,
    pub interactions: InteractionType,
    pub thresholds: Thresholds,
    pub sequence_separation: usize,
    pub skip_hetero: bool,
    pub skip_water: bool,
    pub skip_energy: bool,
    pub perform_msa: bool,
}

Parameters for submitting a job. See the documentation of each parameter for a detailed explanation.

Fields

chain: Chain

Which chain(s) to consider when computing interactions. Default All.

network_policy: NetworkPolicy

Which set of atoms to consider when evaluating contacts. Default Closest.

interactions: InteractionType

How many interactions to report per edge per type. Default Multiple.

thresholds: Thresholds

Max distances between two pairs of atoms to consider as interacting. Default strict.

sequence_separation: usize

Maximal distance between residues to consider at once. Default 3.

skip_hetero: bool

Skip hetero atoms and ligands. Default false.

skip_water: bool

Skip water (solvent) molecules. Default true.

skip_energy: bool

Skip FRST and TAP energy calculation. Default true.

perform_msa: bool

Calculate mutual information from a multiple alignment via BLAST (slow!) Default false.

Trait Implementations

impl PartialEq<Settings> for Settings

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for Settings

impl Default for Settings

fn default() -> Self

Returns the "default value" for a type.

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Serialize for Settings

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Settings

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

Deserialize this value from the given Serde deserializer.