Struct SubscribeParams 

#[non_exhaustive]
pub struct SubscribeParams {
    pub ingest_only: bool,
    pub ignore_session: Option<Uuid>,
    pub area_filter: Option<AreaFilter>,
    pub area_of_interest: Option<AreaOfInterest>,
    pub bandwidth: Option<BandwidthLimits>,
}

Controls which changes are delivered to a folder subscriber.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ingest_only: bool

ignore_session: Option<Uuid>

area_filter: Option<AreaFilter>

area_of_interest: Option<AreaOfInterest>

bandwidth: Option<BandwidthLimits>

Implementations

impl SubscribeParams

pub const fn ingest_only() -> Self

pub const fn ignore_session(session_id: Uuid) -> Self

pub fn with_area(self, area_filter: AreaFilter) -> Self

pub fn with_limits(self, area: AreaOfInterest) -> Self

pub const fn with_bandwidth_limits(self, bandwidth: BandwidthLimits) -> Self

pub fn accepts(&self, path: &Path, hash: &Hash) -> bool

Trait Implementations

impl Clone for SubscribeParams

fn clone(&self) -> SubscribeParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscribeParams

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

Formats the value using the given formatter.

impl Default for SubscribeParams

fn default() -> SubscribeParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubscribeParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SubscribeParams

impl PartialEq for SubscribeParams

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SubscribeParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SubscribeParams