Skip to main content

FeedDescriptor

Struct FeedDescriptor 

Source
pub struct FeedDescriptor {
    pub name: String,
    pub schema: WireSchema,
    pub transports: Vec<TransportTag>,
    pub formats: Vec<FormatPreference>,
    pub capabilities: Capabilities,
    pub event_time_key: Option<String>,
    pub tags: Vec<String>,
    pub description: Option<String>,
}
Expand description

Single named live feed, as advertised by a publisher.

A descriptor is information-only: it describes what the feed is and how it can be consumed. The matching producer-side handle lives in live-stream.

Fields§

§name: String

Stable identifier for the feed, unique within a single publisher.

§schema: WireSchema

Schema every emitted batch on the feed conforms to.

§transports: Vec<TransportTag>

Transports the publisher is currently accepting subscriptions over.

§formats: Vec<FormatPreference>

Formats the publisher can serialise batches into.

§capabilities: Capabilities

What the publisher is willing to do server-side at subscribe time.

§event_time_key: Option<String>

Name of the column carrying the canonical event timestamp on this feed. Optional in the manifest grammar so future non-temporal feeds remain expressible, always populated for streaming market data feeds.

§tags: Vec<String>

Free-form classification tags, e.g. ["finance", "ticks"].

§description: Option<String>

Optional human-readable description.

Implementations§

Source§

impl FeedDescriptor

Source

pub fn new(name: impl Into<String>, schema: WireSchema) -> Self

Trait Implementations§

Source§

impl Clone for FeedDescriptor

Source§

fn clone(&self) -> FeedDescriptor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FeedDescriptor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for FeedDescriptor

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for FeedDescriptor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for FeedDescriptor

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for FeedDescriptor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,