Enum BusPayloadType 

pub enum BusPayloadType {
    Custom(Ustr),
    Instrument,
    OrderBookDeltas,
    OrderBookDepth,
    QuoteTick,
    TradeTick,
    Bar,
    MarkPriceUpdate,
    IndexPriceUpdate,
    FundingRateUpdate,
    OptionGreeks,
    AccountState,
    OrderEvent,
    PositionEvent,
    PortfolioSnapshot,
    SubscribeCommand,
    UnsubscribeCommand,
    TradingCommand,
    GenerateExecutionMassStatus,
    OrderStatusReport,
    FillReport,
    PositionStatusReport,
    ExecutionMassStatus,
    Block,
    Pool,
    PoolLiquidityUpdate,
    PoolFeeCollect,
    PoolFlash,
}

The payload type carried by a BusMessage.

The fixed variants cover every type the bus publishes externally; BusPayloadType::Custom carries the user-defined type name for arbitrary custom data. Untagged variants serialize as flat name strings such as "QuoteTick". Typed message variants serialize as {"typed":"<name>"} so they remain distinct from custom payloads with the same name. Redis carries the discriminator as payload_kind=typed next to its flat type field. Without it, BusPayloadType::from_name resolves a typed name as BusPayloadType::Custom.

Variants

Custom(Ustr)

User-defined custom data, identified by its type name.

Instrument

OrderBookDeltas

OrderBookDepth

QuoteTick

TradeTick

Bar

MarkPriceUpdate

IndexPriceUpdate

FundingRateUpdate

OptionGreeks

AccountState

OrderEvent

PositionEvent

PortfolioSnapshot

SubscribeCommand

UnsubscribeCommand

TradingCommand

GenerateExecutionMassStatus

OrderStatusReport

FillReport

PositionStatusReport

ExecutionMassStatus

Block

Pool

PoolLiquidityUpdate

PoolFeeCollect

PoolFlash

Implementations

impl BusPayloadType

pub fn as_str(&self) -> &str

Returns the canonical type name for this payload type.

The name alone does not identify variants for which Self::is_typed_message returns true.

pub fn from_name(name: &str) -> Self

Resolves an untagged canonical type name to a BusPayloadType.

Typed message and unknown names resolve to BusPayloadType::Custom. Use BusPayloadType::from_typed_name when a separate discriminator identifies a typed payload.

pub fn from_typed_name(name: &str) -> Option<Self>

Resolves a discriminated typed name to its fixed payload type.

Returns None when the name does not identify a typed message variant.

pub const fn is_typed_message(self) -> bool

Returns whether this payload type uses the typed discriminator.

pub fn category(&self) -> BusPayloadCategory

Returns the encoding policy category for this payload type.

pub fn supports(&self, encoding: SerializationEncoding) -> bool

Returns whether this payload type supports the given bus serialization encoding.

Trait Implementations

impl Clone for BusPayloadType

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BusPayloadType

impl Debug for BusPayloadType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BusPayloadType

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

Deserialize this value from the given Serde deserializer.

impl Display for BusPayloadType

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

Formats the value using the given formatter.

impl Eq for BusPayloadType

impl Hash for BusPayloadType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BusPayloadType

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BusPayloadType

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BusPayloadType