Struct Contract 

pub struct Contract {
    pub plan: Plan,
    pub group_specs: Vec<GroupSpec>,
    pub field_addresses: Option<BTreeMap<String, u64>>,
    /* private fields */
}

A rank’s cache transfer contract.

Fields

plan: Plan

The memory plan.

group_specs: Vec<GroupSpec>

The groups’ semantics, in the scheduler’s order.

field_addresses: Option<BTreeMap<String, u64>>

The fields’ landing addresses, on an endpoint’s contract; absent in the rank-independent bootstrap layout.

Implementations

impl Contract

pub fn from_wire(raw: &[u8]) -> Result<Self, LayoutError>

Parse a contract off the wire (CacheTransferContract.from_wire_bytes).

pub fn new( plan: Plan, group_specs: Vec<GroupSpec>, partitions: Vec<(String, Partition)>, field_addresses: Option<BTreeMap<String, u64>>, ) -> Result<Self, LayoutError>

A contract from its parts, checked as the Python constructor checks it.

pub fn without_addresses(&self) -> Self

The same contract without its landing addresses: the logical layout every rank of a node registers with the bootstrap server.

pub fn group_spec(&self, group_id: &str) -> Result<&GroupSpec, LayoutError>

The group’s semantics.

pub fn group(&self, group_id: &str) -> Result<&GroupLayout, LayoutError>

The group’s geometry.

pub fn field(&self, field_id: &str) -> Result<&FieldLayout, LayoutError>

A field’s geometry.

pub fn fields_for_group(&self, group_id: &str) -> Vec<&FieldLayout>

The group’s fields, sorted by field id (fields_for_group).

pub fn shard_count(&self, group_id: &str) -> Result<i64, LayoutError>

The group’s cyclic owner count; one means replicated.

pub fn virtual_block_count(&self, group_id: &str) -> Result<i64, LayoutError>

The exclusive bound of the scheduler block ids a manifest of the group may carry (virtual_block_count).

pub fn partition_for(&self, field_id: &str) -> Option<&Partition>

A field’s TP partition, if it has one.

pub fn field_page_byte_offset( &self, field_id: &str, page_id: i64, ) -> Result<i64, LayoutError>

One field page’s byte offset in the arena (field_page_byte_offset).

pub fn field_address( &self, base: u64, field_id: &str, ) -> Result<i128, LayoutError>

Where a field’s page 0 lands for an arena at base: its advertised address on an endpoint’s contract, else base plus its offset.

Trait Implementations

impl Clone for Contract

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 Contract

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

Formats the value using the given formatter.

impl Eq for Contract

impl PartialEq for Contract

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

Equality operator ==.

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

Inequality operator !=.