async_nats/jetstream/kv/
bucket.rs

1// Copyright 2020-2022 The NATS Authors
2// Licensed under the Apache License, Version 2.0 (the "License");
3// you may not use this file except in compliance with the License.
4// You may obtain a copy of the License at
5//
6// http://www.apache.org/licenses/LICENSE-2.0
7//
8// Unless required by applicable law or agreed to in writing, software
9// distributed under the License is distributed on an "AS IS" BASIS,
10// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11// See the License for the specific language governing permissions and
12// limitations under the License.
13
14use std::time::Duration;
15
16use crate::jetstream::stream::Info;
17
18/// Represents status information about a key value store bucket
19#[derive(Debug)]
20pub struct Status {
21    pub info: Info,
22    pub bucket: String,
23}
24
25impl Status {
26    /// The name of the bucket
27    pub fn bucket(&self) -> &str {
28        &self.bucket
29    }
30
31    /// How many messages are in the bucket, including historical values
32    pub fn values(&self) -> u64 {
33        self.info.state.messages
34    }
35
36    /// Configured history kept per key
37    pub fn history(&self) -> i64 {
38        self.info.config.max_messages_per_subject
39    }
40
41    /// How long the bucket keeps values for
42    pub fn max_age(&self) -> Duration {
43        self.info.config.max_age
44    }
45}
async_nats/jetstream/kv/bucket.rs

async_nats/jetstream/kv/
bucket.rs
