Struct CapGroupRecord

pub struct CapGroupRecord {
    pub cap: CapGroup,
    pub principal: u128,
}

Record tracking the state of a cap group.

Fields

cap: CapGroup

The cap group configuration.

principal: u128

Current total principal allocated to markets in this group.

Implementations

impl CapGroupRecord

pub fn apply_allocation(&self, amount: u128) -> CapGroupRecord

Apply an allocation to a cap group record.

pub fn remove_allocation(&self, amount: u128) -> CapGroupRecord

Remove allocation from a cap group record.

pub fn can_allocate(&self, amount: u128, total_assets: u128) -> bool

Check if an allocation is allowed.

pub fn enforce( &self, amount: u128, total_assets: u128, ) -> Result<(), CapGroupError>

Enforce cap constraints.

pub fn available_capacity(&self, total_assets: u128) -> u128

Get available capacity.

Trait Implementations

impl BorshDeserialize for CapGroupRecord

fn deserialize_reader<__R>(reader: &mut __R) -> Result<CapGroupRecord, Error>

where __R: Read,

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSchema for CapGroupRecord

fn declaration() -> String

Get the name of the type without brackets.

fn add_definitions_recursively(definitions: &mut BTreeMap<String, Definition>)

Recursively, using DFS, add type definitions required for this type. Type definition partially explains how to serialize/deserialize a type.

impl BorshSerialize for CapGroupRecord

fn serialize<__W>(&self, writer: &mut __W) -> Result<(), Error>

where __W: Write,

impl Clone for CapGroupRecord

fn clone(&self) -> CapGroupRecord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CapGroupRecord

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

Formats the value using the given formatter.

impl Default for CapGroupRecord

fn default() -> CapGroupRecord

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CapGroupRecord

fn deserialize<__D>( __deserializer: __D, ) -> Result<CapGroupRecord, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CapGroup> for CapGroupRecord

fn from(cap: CapGroup) -> CapGroupRecord

Converts to this type from the input type.

impl JsonSchema for CapGroupRecord

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for CapGroupRecord

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

where __S: Serializer,

Serialize this value into the given Serde serializer.