Skip to main content

SubscriptionDescriptor

Struct SubscriptionDescriptor 

Source
pub struct SubscriptionDescriptor {
    pub feed: String,
    pub columns: Option<Vec<String>>,
    pub filter: FilterExpr,
    pub sampling: Option<Sampling>,
    pub transport_pref: TransportPreference,
    pub format_pref: Option<FormatPreference>,
}
Expand description

Request to open one feed.

Every field except feed is optional and represents a preference. A 0.1.0 publisher honours columns and ignores filter and sampling unless Capabilities advertises support.

Fields§

§feed: String

Name of the feed, matching a FeedDescriptor::name.

§columns: Option<Vec<String>>

Subset of columns to receive. None means “all columns”.

§filter: FilterExpr

Row-level filter applied server-side. 0.1.0 servers refuse anything other than FilterExpr::Empty.

§sampling: Option<Sampling>

Optional sampling policy, e.g. “every Nth batch”.

§transport_pref: TransportPreference

Ordered transport preference. Empty means “any”.

§format_pref: Option<FormatPreference>

Preferred batch format. None means “publisher’s default”.

Implementations§

Source§

impl SubscriptionDescriptor

Source

pub fn new(feed: impl Into<String>) -> Self

Source

pub fn columns<I, S>(self, cols: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Source

pub fn transport_pref(self, pref: TransportPreference) -> Self

Source

pub fn format(self, fmt: FormatPreference) -> Self

Source

pub fn sampling(self, sampling: Sampling) -> Self

Trait Implementations§

Source§

impl Clone for SubscriptionDescriptor

Source§

fn clone(&self) -> SubscriptionDescriptor

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 SubscriptionDescriptor

Source§

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

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

impl<'de> Deserialize<'de> for SubscriptionDescriptor

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 SubscriptionDescriptor

Source§

fn eq(&self, other: &SubscriptionDescriptor) -> 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 SubscriptionDescriptor

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 SubscriptionDescriptor

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>,