Skip to main content

StreamCommand

Enum StreamCommand 

Source
pub enum StreamCommand {
Show 19 variants CreateBucket { bucket_id: String, }, DeleteBucket { bucket_id: String, }, CreateStream { stream_id: BucketStreamId, content_type: String, initial_payload: Bytes, close_after: bool, stream_seq: Option<String>, producer: Option<ProducerRequest>, stream_ttl_seconds: Option<u64>, stream_expires_at_ms: Option<u64>, attrs: Option<StreamAttrs>, now_ms: u64, }, CreateExternal { stream_id: BucketStreamId, content_type: String, initial_payload: ExternalPayloadRef, record_ends: Vec<u64>, close_after: bool, stream_seq: Option<String>, producer: Option<ProducerRequest>, stream_ttl_seconds: Option<u64>, stream_expires_at_ms: Option<u64>, attrs: Option<StreamAttrs>, now_ms: u64, }, Append { stream_id: BucketStreamId, content_type: Option<String>, payload: Bytes, close_after: bool, stream_seq: Option<String>, producer: Option<ProducerRequest>, now_ms: u64, record_match: Option<u64>, }, AppendExternal { stream_id: BucketStreamId, content_type: Option<String>, payload: ExternalPayloadRef, record_ends: Vec<u64>, close_after: bool, stream_seq: Option<String>, producer: Option<ProducerRequest>, now_ms: u64, record_match: Option<u64>, }, AppendBatch { stream_id: BucketStreamId, content_type: Option<String>, payloads: Vec<Bytes>, producer: Option<ProducerRequest>, now_ms: u64, }, PublishSnapshot { stream_id: BucketStreamId, snapshot_offset: u64, content_type: String, payload: Bytes, expected_digest: Option<String>, now_ms: u64, }, AdvanceRetention { stream_id: BucketStreamId, retained_offset: u64, now_ms: u64, }, TouchStreamAccess { stream_id: BucketStreamId, now_ms: u64, renew_ttl: bool, }, UpdateStreamAttrs { stream_id: BucketStreamId, attrs: Option<StreamAttrs>, now_ms: u64, }, FlushCold { stream_id: BucketStreamId, chunk: ColdChunkRef, }, CompactCold { stream_id: BucketStreamId, old_chunks: Vec<ColdChunkRef>, replacement: ColdChunkRef, gc_not_before_ms: u64, }, Close { stream_id: BucketStreamId, stream_seq: Option<String>, producer: Option<ProducerRequest>, now_ms: u64, }, DeleteStream { stream_id: BucketStreamId, }, PurgeBucket { bucket_id: String, }, AckColdGc { up_to_seq: u64, }, ImportSnapshot { snapshot: Box<StreamSnapshot>, }, SetBucketQuota { bucket_id: String, max_streams: Option<u64>, max_retained_bytes: Option<u64>, },
}

Variants§

§

CreateBucket

Fields

§bucket_id: String
§

DeleteBucket

Fields

§bucket_id: String
§

CreateStream

Fields

§stream_id: BucketStreamId
§content_type: String
§initial_payload: Bytes
§close_after: bool
§stream_seq: Option<String>
§stream_ttl_seconds: Option<u64>
§stream_expires_at_ms: Option<u64>
§now_ms: u64
§

CreateExternal

Fields

§stream_id: BucketStreamId
§content_type: String
§initial_payload: ExternalPayloadRef
§record_ends: Vec<u64>
§close_after: bool
§stream_seq: Option<String>
§stream_ttl_seconds: Option<u64>
§stream_expires_at_ms: Option<u64>
§now_ms: u64
§

Append

Fields

§stream_id: BucketStreamId
§content_type: Option<String>
§payload: Bytes
§close_after: bool
§stream_seq: Option<String>
§now_ms: u64
§record_match: Option<u64>
§

AppendExternal

Fields

§stream_id: BucketStreamId
§content_type: Option<String>
§record_ends: Vec<u64>
§close_after: bool
§stream_seq: Option<String>
§now_ms: u64
§record_match: Option<u64>
§

AppendBatch

Fields

§stream_id: BucketStreamId
§content_type: Option<String>
§payloads: Vec<Bytes>
§now_ms: u64
§

PublishSnapshot

Fields

§stream_id: BucketStreamId
§snapshot_offset: u64
§content_type: String
§payload: Bytes
§expected_digest: Option<String>
§now_ms: u64
§

AdvanceRetention

Fields

§stream_id: BucketStreamId
§retained_offset: u64
§now_ms: u64
§

TouchStreamAccess

Fields

§stream_id: BucketStreamId
§now_ms: u64
§renew_ttl: bool
§

UpdateStreamAttrs

Fields

§stream_id: BucketStreamId
§now_ms: u64
§

FlushCold

Fields

§stream_id: BucketStreamId
§

CompactCold

Replaces a contiguous run of immutable cold chunks with one equivalent object. The external cold-index page update is completed before this command is replicated; applying it schedules the old paths for delayed reclamation.

Fields

§stream_id: BucketStreamId
§old_chunks: Vec<ColdChunkRef>
§replacement: ColdChunkRef
§gc_not_before_ms: u64
§

Close

Fields

§stream_id: BucketStreamId
§stream_seq: Option<String>
§now_ms: u64
§

DeleteStream

Fields

§stream_id: BucketStreamId
§

PurgeBucket

Administrator-triggered tenant offboarding: removes every stream in the bucket, the bucket itself, and its quota in this group. Monotonic aggregate usage is retained for asynchronous accounting. Idempotent — purging an absent bucket reports zero removals.

Fields

§bucket_id: String
§

AckColdGc

Confirms the leader’s background worker has physically reclaimed every queued cold-GC entry with seq <= up_to_seq; removes them from the replicated queue. Idempotent under replay.

Fields

§up_to_seq: u64
§

ImportSnapshot

Replaces this group’s entire state with a backup snapshot.

Restore-only: the target group must be empty. Travelling as a normal replicated command keeps every replica of the restored cluster deterministic while the cluster retains its own raft identity and membership – nothing from the backed-up cluster’s raft metadata is reused.

Fields

§

SetBucketQuota

Sets or clears this group’s data-plane quota record for a bucket. Replicated to every group so each enforces the same local backstop; both limits None removes the record. Idempotent under replay.

Fields

§bucket_id: String
§max_streams: Option<u64>
§max_retained_bytes: Option<u64>

Trait Implementations§

Source§

impl Clone for StreamCommand

Source§

fn clone(&self) -> StreamCommand

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 StreamCommand

Source§

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

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

impl<'de> Deserialize<'de> for StreamCommand

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 Display for StreamCommand

Source§

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

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

impl Eq for StreamCommand

Source§

impl PartialEq for StreamCommand

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for StreamCommand

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 StreamCommand

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> Same for T

Source§

type Output = T

Should always be Self
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.