Struct AuthData

pub struct AuthData {
    pub min_rate: f64,
    pub max_rate: f64,
    pub min_trade: f64,
    pub max_trade: f64,
}

The supported constraints for an authorization.

An AuthData defines the trading constraints for an authorization:

• Rate constraints limit how fast a portfolio can be traded (in units per time)
• Trade constraints limit the total accumulated trade amount over time

The rate constraints must allow the possibility of zero trade (min_rate ≤ 0 ≤ max_rate).

The trade constraints do not have this restriction, but instead, at time of specification, they should allow for the currently traded amount of the auth. If they do not, the trade constraint is implicitly expanded to include 0 at each auction, which may not be desired.

Fields

min_rate: f64

The fastest rate at which the portfolio may sell (non-positive)

max_rate: f64

The fastest rate at which the portfolio may buy (non-negative)

min_trade: f64

A minimum amount of trade to preserve (always enforced against the authorization’s contemporaneous amount of trade)

max_trade: f64

A maximum amount of trade to preserve (always enforced against the authorization’s contemporaneous amount of trade)

Implementations

impl AuthData

pub fn new( min_rate: f64, max_rate: f64, min_trade: f64, max_trade: f64, ) -> Result<Self, ValidationError>

Creates a new AuthData with the specified constraints.

Trait Implementations

impl Clone for AuthData

fn clone(&self) -> AuthData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for AuthData

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for AuthData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AuthData

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AuthData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for AuthData

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

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl StructuralPartialEq for AuthData