1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
// Copyright 2020-2022 The NATS Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
//! Manage operations on a [Stream], create/delete/update [Consumer][crate::jetstream::consumer::Consumer].
use std::{
io::{self, ErrorKind},
time::Duration,
};
use crate::Error;
use serde::{Deserialize, Serialize};
use serde_json::json;
use time::serde::rfc3339;
use super::{
consumer::{self, Consumer, FromConsumer, IntoConsumerConfig},
response::Response,
Context,
};
/// Handle to operations that can be performed on a `Stream`.
#[derive(Debug)]
pub struct Stream {
pub(crate) info: Info,
pub(crate) context: Context,
}
impl Stream {
/// Retrieves `info` about [Stream] from the server, updates the cached `info` inside
/// [Stream] and returns it.
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// let client = async_nats::connect("localhost:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
///
/// let mut stream = jetstream
/// .get_stream("events").await?;
///
/// let info = stream.info().await?;
/// # Ok(())
/// # }
/// ```
pub async fn info(&mut self) -> Result<&Info, Error> {
let subject = format!("STREAM.INFO.{}", self.info.config.name);
match self.context.request(subject, &json!({})).await? {
Response::Ok::<Info>(info) => {
self.info = info;
Ok(&self.info)
}
Response::Err { error } => Err(Box::new(std::io::Error::new(
ErrorKind::Other,
format!(
"nats: error while getting stream info: {}, {}, {}",
error.code, error.status, error.description
),
))),
}
}
/// Returns cached [Info] for the [Stream].
/// Cache is either from initial creation/retrival of the [Stream] or last call to
/// [Stream::info].
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// let client = async_nats::connect("localhost:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
///
/// let stream = jetstream
/// .get_stream("events").await?;
///
/// let info = stream.cached_info();
/// # Ok(())
/// # }
/// ```
pub fn cached_info(&self) -> &Info {
&self.info
}
/// Get a raw message from the stream.
///
/// # Examples
///
/// ```no_run
/// #[tokio::main]
/// # async fn mains() -> Result<(), async_nats::Error> {
/// use futures::StreamExt;
/// use futures::TryStreamExt;
///
/// let client = async_nats::connect("localhost:4222").await?;
/// let context = async_nats::jetstream::new(client);
///
/// let stream = context.get_or_create_stream(async_nats::jetstream::stream::Config {
/// name: "events".to_string(),
/// max_messages: 10_000,
/// ..Default::default()
/// }).await?;
///
/// let publish_ack = context.publish("events".to_string(), "data".into()).await?;
/// let raw_message = stream.get_raw_message(publish_ack.sequence).await?;
/// println!("Retreived raw message {:?}", raw_message);
/// # Ok(())
/// # }
/// ```
pub async fn get_raw_message(&self, sequence: u64) -> Result<RawMessage, Error> {
let subject = format!("STREAM.MSG.GET.{}", &self.info.config.name);
let payload = json!({
"seq": sequence,
});
let response: Response<GetRawMessage> = self.context.request(subject, &payload).await?;
match response {
Response::Err { error } => Err(Box::new(std::io::Error::new(
ErrorKind::Other,
format!(
"nats: error while getting message: {}, {}",
error.code, error.description
),
))),
Response::Ok(value) => Ok(value.message),
}
}
/// Get the last raw message from the stream by subject.
///
/// # Examples
///
/// ```no_run
/// #[tokio::main]
/// # async fn mains() -> Result<(), async_nats::Error> {
/// use futures::StreamExt;
/// use futures::TryStreamExt;
///
/// let client = async_nats::connect("localhost:4222").await?;
/// let context = async_nats::jetstream::new(client);
///
/// let stream = context.get_or_create_stream(async_nats::jetstream::stream::Config {
/// name: "events".to_string(),
/// max_messages: 10_000,
/// ..Default::default()
/// }).await?;
///
/// let publish_ack = context.publish("events".to_string(), "data".into()).await?;
/// let raw_message = stream.get_last_raw_message_by_subject("events".into()).await?;
/// println!("Retreived raw message {:?}", raw_message);
/// # Ok(())
/// # }
/// ```
pub async fn get_last_raw_message_by_subject(
&self,
stream_subject: &str,
) -> Result<RawMessage, Error> {
let subject = format!("STREAM.MSG.GET.{}", &self.info.config.name);
let payload = json!({
"last_by_subj": stream_subject,
});
let response: Response<GetRawMessage> = self.context.request(subject, &payload).await?;
match response {
Response::Err { error } => Err(Box::new(std::io::Error::new(
ErrorKind::Other,
format!(
"nats: error while getting message: {}, {}",
error.code, error.description
),
))),
Response::Ok(value) => Ok(value.message),
}
}
/// Delete a message from the stream.
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// let client = async_nats::connect("localhost:4222").await?;
/// let context = async_nats::jetstream::new(client);
///
/// let stream = context.get_or_create_stream(async_nats::jetstream::stream::Config {
/// name: "events".to_string(),
/// max_messages: 10_000,
/// ..Default::default()
/// }).await?;
///
/// let publish_ack = context.publish("events".to_string(), "data".into()).await?;
/// stream.delete_message(publish_ack.sequence).await?;
/// # Ok(())
/// # }
/// ```
pub async fn delete_message(&self, sequence: u64) -> Result<bool, Error> {
let subject = format!("STREAM.MSG.DELETE.{}", &self.info.config.name);
let payload = json!({
"seq": sequence,
});
let response: Response<DeleteStatus> = self.context.request(subject, &payload).await?;
match response {
Response::Err { error } => Err(Box::new(std::io::Error::new(
ErrorKind::Other,
format!(
"nats: error while deleting message: {}, {}",
error.code, error.status
),
))),
Response::Ok(value) => Ok(value.success),
}
}
/// Purge `Stream` messages.
///
/// # Examples
///
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// let client = async_nats::connect("demo.nats.io").await?;
/// let jetstream = async_nats::jetstream::new(client);
///
/// let stream = jetstream.get_stream("events").await?;
/// stream.purge().await?;
/// # Ok(())
/// # }
pub async fn purge(&self) -> Result<PurgeResponse, Error> {
let subject = format!("STREAM.PURGE.{}", self.info.config.name);
let response: Response<PurgeResponse> = self.context.request(subject, &()).await?;
match response {
Response::Err { error } => Err(Box::new(io::Error::new(
ErrorKind::Other,
format!(
"error while purging stream: {}, {}, {}",
error.code, error.status, error.description
),
))),
Response::Ok(response) => Ok(response),
}
}
/// Purge `Stream` messages for a matching subject.
///
/// # Examples
///
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// let client = async_nats::connect("demo.nats.io").await?;
/// let jetstream = async_nats::jetstream::new(client);
///
/// let stream = jetstream.get_stream("events").await?;
/// stream.purge_subject("data").await?;
/// # Ok(())
/// # }
pub async fn purge_subject<T>(&self, subject: T) -> Result<PurgeResponse, Error>
where
T: Into<String>,
{
let request_subject = format!("STREAM.PURGE.{}", self.info.config.name);
let response: Response<PurgeResponse> = self
.context
.request(
request_subject,
&PurgeRequest {
filter: Some(subject.into()),
..Default::default()
},
)
.await?;
match response {
Response::Err { error } => Err(Box::new(io::Error::new(
ErrorKind::Other,
format!(
"error while purging stream: {}, {}, {}",
error.code, error.status, error.description
),
))),
Response::Ok(response) => Ok(response),
}
}
/// Create a new `Durable` or `Ephemeral` Consumer (if `durable_name` was not provided) and
/// returns the info from the server about created [Consumer][Consumer]
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// use async_nats::jetstream::consumer;
/// let client = async_nats::connect("localhost:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
///
/// let stream = jetstream.get_stream("events").await?;
/// let info = stream.create_consumer(consumer::pull::Config {
/// durable_name: Some("pull".to_string()),
/// ..Default::default()
/// }).await?;
/// # Ok(())
/// # }
/// ```
pub async fn create_consumer<C: IntoConsumerConfig + FromConsumer>(
&self,
config: C,
) -> Result<Consumer<C>, Error> {
let config = config.into_consumer_config();
let subject = if let Some(ref durable_name) = config.durable_name {
format!(
"CONSUMER.DURABLE.CREATE.{}.{}",
self.info.config.name, durable_name
)
} else {
format!("CONSUMER.CREATE.{}", self.info.config.name)
};
match self
.context
.request(
subject,
&json!({"stream_name": self.info.config.name.clone(), "config": config}),
)
.await?
{
Response::Err { error } => Err(Box::new(std::io::Error::new(
ErrorKind::Other,
format!(
"nats: error while creating stream: {}, {}, {}",
error.code, error.status, error.description
),
))),
Response::Ok::<consumer::Info>(info) => Ok(Consumer::new(
FromConsumer::try_from_consumer_config(info.clone().config)?,
info,
self.context.clone(),
)),
}
}
/// Retrieve [Info] about [Consumer] from the server.
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// use async_nats::jetstream::consumer;
/// let client = async_nats::connect("localhost:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
///
/// let stream = jetstream.get_stream("events").await?;
/// let info = stream.consumer_info("pull").await?;
/// # Ok(())
/// # }
/// ```
pub async fn consumer_info<T: AsRef<str>>(&self, name: T) -> Result<consumer::Info, Error> {
let name = name.as_ref();
let subject = format!("CONSUMER.INFO.{}.{}", self.info.config.name, name);
match self.context.request(subject, &json!({})).await? {
Response::Ok(info) => Ok(info),
Response::Err { error } => Err(Box::new(std::io::Error::new(
ErrorKind::Other,
format!(
"nats: error while getting consumer info: {}, {}, {}",
error.code, error.status, error.description
),
))),
}
}
/// Get [Consumer] from the the server. [Consumer] iterators can be used to retrieve
/// [Messages][crate::jetstream::Message] for a given [Consumer].
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// use async_nats::jetstream::consumer;
/// use futures::StreamExt;
/// let client = async_nats::connect("localhost:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
///
/// let stream = jetstream.get_stream("events").await?;
/// let consumer: consumer::PullConsumer = stream.get_consumer("pull").await?;
/// # Ok(())
/// # }
/// ```
pub async fn get_consumer<T: FromConsumer + IntoConsumerConfig>(
&self,
name: &str,
) -> Result<Consumer<T>, Error> {
let info = self.consumer_info(name).await?;
Ok(Consumer::new(
T::try_from_consumer_config(info.config.clone())?,
info,
self.context.clone(),
))
}
/// Create a [Consumer] with the given configuration if it is not present on the server. Returns a handle to the [Consumer].
///
/// Note: This does not validate if the [Consumer] on the server is compatible with the configuration passed in except Push/Pull compatibility.
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// use async_nats::jetstream::consumer;
/// use futures::StreamExt;
/// let client = async_nats::connect("localhost:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
///
/// let stream = jetstream.get_stream("events").await?;
/// let consumer = stream.get_or_create_consumer("pull", consumer::pull::Config {
/// durable_name: Some("pull".to_string()),
/// ..Default::default()
/// }).await?;
/// # Ok(())
/// # }
/// ```
pub async fn get_or_create_consumer<T: FromConsumer + IntoConsumerConfig>(
&self,
name: &str,
config: T,
) -> Result<Consumer<T>, Error> {
let subject = format!("CONSUMER.INFO.{}.{}", self.info.config.name, name);
match self.context.request(subject, &json!({})).await? {
Response::Err { error } if error.status == 404 => self.create_consumer(config).await,
Response::Err { error } => Err(Box::new(io::Error::new(
ErrorKind::Other,
format!(
"nats: error while getting or creating stream: {}, {}, {}",
error.code, error.status, error.description
),
))),
Response::Ok::<consumer::Info>(info) => Ok(Consumer::new(
T::try_from_consumer_config(info.config.clone())?,
info,
self.context.clone(),
)),
}
}
/// Delete a [Consumer] from the server.
///
/// # Examples
///
/// ```no_run
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// use async_nats::jetstream::consumer;
/// use futures::StreamExt;
/// let client = async_nats::connect("localhost:4222").await?;
/// let jetstream = async_nats::jetstream::new(client);
///
/// jetstream.get_stream("events").await?
/// .delete_consumer("pull").await?;
/// # Ok(())
/// # }
/// ```
pub async fn delete_consumer(&self, name: &str) -> Result<DeleteStatus, Error> {
let subject = format!("CONSUMER.DELETE.{}.{}", self.info.config.name, name);
match self.context.request(subject, &json!({})).await? {
Response::Ok(delete_status) => Ok(delete_status),
Response::Err { error } => Err(Box::new(std::io::Error::new(
ErrorKind::Other,
format!(
"nats: error while deleting consumer: {}, {}, {}",
error.code, error.status, error.description
),
))),
}
}
}
/// `StreamConfig` determines the properties for a stream.
/// There are sensible defaults for most. If no subjects are
/// given the name will be used as the only subject.
#[derive(Debug, Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
pub struct Config {
/// A name for the Stream. Must not have spaces, tabs or period `.` characters
pub name: String,
/// How large the Stream may become in total bytes before the configured discard policy kicks in
pub max_bytes: i64,
/// How large the Stream may become in total messages before the configured discard policy kicks in
#[serde(rename = "max_msgs")]
pub max_messages: i64,
/// Maximum amount of messages to keep per subject
#[serde(rename = "max_msgs_per_subject")]
pub max_messages_per_subject: i64,
/// When a Stream has reached its configured `max_bytes` or `max_msgs`, this policy kicks in.
/// `DiscardPolicy::New` refuses new messages or `DiscardPolicy::Old` (default) deletes old messages to make space
pub discard: DiscardPolicy,
/// Which NATS subjects to populate this stream with. Supports wildcards. Defaults to just the
/// configured stream `name`.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub subjects: Vec<String>,
/// How message retention is considered, `Limits` (default), `Interest` or `WorkQueue`
pub retention: RetentionPolicy,
/// How many Consumers can be defined for a given Stream, -1 for unlimited
pub max_consumers: i32,
/// Maximum age of any message in the stream, expressed in nanoseconds
#[serde(with = "serde_nanos")]
pub max_age: Duration,
/// The largest message that will be accepted by the Stream
#[serde(default, skip_serializing_if = "is_default", rename = "max_msg_size")]
pub max_message_size: i32,
/// The type of storage backend, `File` (default) and `Memory`
pub storage: StorageType,
/// How many replicas to keep for each message in a clustered JetStream, maximum 5
pub num_replicas: usize,
/// Disables acknowledging messages that are received by the Stream
#[serde(default, skip_serializing_if = "is_default")]
pub no_ack: bool,
/// The window within which to track duplicate messages.
#[serde(default, skip_serializing_if = "is_default")]
pub duplicate_window: i64,
/// The owner of the template associated with this stream.
#[serde(default, skip_serializing_if = "is_default")]
pub template_owner: String,
/// Indicates the stream is sealed and cannot be modified in any way
#[serde(default, skip_serializing_if = "is_default")]
pub sealed: bool,
#[serde(default, skip_serializing_if = "is_default")]
/// A short description of the purpose of this stream.
pub description: Option<String>,
#[serde(
default,
rename = "allow_rollup_hdrs",
skip_serializing_if = "is_default"
)]
/// Indicates if rollups will be allowed or not.
pub allow_rollup: bool,
#[serde(default, skip_serializing_if = "is_default")]
/// Indicates deletes will be denied or not.
pub deny_delete: bool,
/// Indicates if purges will be denied or not.
#[serde(default, skip_serializing_if = "is_default")]
pub deny_purge: bool,
#[serde(default, skip_serializing_if = "is_default")]
pub republish: Option<Republish>,
}
impl From<&Config> for Config {
fn from(sc: &Config) -> Config {
sc.clone()
}
}
impl From<&str> for Config {
fn from(s: &str) -> Config {
Config {
name: s.to_string(),
..Default::default()
}
}
}
// Republish is for republishing messages once committed to a stream.
#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
pub struct Republish {
/// Subject that should be republished.
#[serde(rename = "src")]
pub source: String,
/// Subject where messages will be republished.
#[serde(rename = "dest")]
pub destination: String,
/// If true, only headers should be republished.
#[serde(default)]
pub headers_only: bool,
}
/// `DiscardPolicy` determines how we proceed when limits of messages or bytes are hit. The default, `Old` will
/// remove older messages. `New` will fail to store the new message.
#[derive(Debug, Serialize, Deserialize, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum DiscardPolicy {
/// will remove older messages when limits are hit.
#[serde(rename = "old")]
Old = 0,
/// will error on a StoreMsg call when limits are hit
#[serde(rename = "new")]
New = 1,
}
impl Default for DiscardPolicy {
fn default() -> DiscardPolicy {
DiscardPolicy::Old
}
}
/// `RetentionPolicy` determines how messages in a set are retained.
#[derive(Debug, Serialize, Deserialize, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum RetentionPolicy {
/// `Limits` (default) means that messages are retained until any given limit is reached.
/// This could be one of mesages, bytes, or age.
#[serde(rename = "limits")]
Limits = 0,
/// `Interest` specifies that when all known observables have acknowledged a message it can be removed.
#[serde(rename = "interest")]
Interest = 1,
/// `WorkQueue` specifies that when the first worker or subscriber acknowledges the message it can be removed.
#[serde(rename = "workqueue")]
WorkQueue = 2,
}
impl Default for RetentionPolicy {
fn default() -> RetentionPolicy {
RetentionPolicy::Limits
}
}
/// determines how messages are stored for retention.
#[derive(Debug, Serialize, Deserialize, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum StorageType {
/// Stream data is kept in files. This is the default.
#[serde(rename = "file")]
File = 0,
/// Stream data is kept only in memory.
#[serde(rename = "memory")]
Memory = 1,
}
impl Default for StorageType {
fn default() -> StorageType {
StorageType::File
}
}
/// Shows config and current state for this stream.
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct Info {
/// The configuration associated with this stream
pub config: Config,
/// The time that this stream was created
#[serde(with = "rfc3339")]
pub created: time::OffsetDateTime,
/// Various metrics associated with this stream
pub state: State,
///information about leader and replicas
#[serde(default)]
pub cluster: Option<ClusterInfo>,
}
#[derive(Deserialize)]
pub struct DeleteStatus {
pub success: bool,
}
/// information about the given stream.
#[derive(Debug, Serialize, Deserialize, Clone, Copy)]
pub struct State {
/// The number of messages contained in this stream
pub messages: u64,
/// The number of bytes of all messages contained in this stream
pub bytes: u64,
/// The lowest sequence number still present in this stream
#[serde(rename = "first_seq")]
pub first_sequence: u64,
/// The time associated with the oldest message still present in this stream
#[serde(with = "rfc3339", rename = "first_ts")]
pub first_timestamp: time::OffsetDateTime,
/// The last sequence number assigned to a message in this stream
#[serde(rename = "last_seq")]
pub last_sequence: u64,
/// The time that the last message was received by this stream
#[serde(with = "rfc3339", rename = "last_ts")]
pub last_timestamp: time::OffsetDateTime,
/// The number of consumers configured to consume this stream
pub consumer_count: usize,
}
/// A raw stream message in the representation it is stored.
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct RawMessage {
/// Subject of the message.
#[serde(rename = "subject")]
pub subject: String,
/// Sequence of the message.
#[serde(rename = "seq")]
pub sequence: u64,
/// Raw payload of the message as a base64 encoded string.
#[serde(default, rename = "data")]
pub payload: String,
/// Raw header string, if any.
#[serde(default, rename = "hdrs")]
pub headers: Option<String>,
/// The time the message was published.
#[serde(rename = "time", with = "rfc3339")]
pub time: time::OffsetDateTime,
}
#[derive(Debug, Serialize, Deserialize, Clone)]
struct GetRawMessage {
pub(crate) message: RawMessage,
}
fn is_default<T: Default + Eq>(t: &T) -> bool {
t == &T::default()
}
/// Information about the stream's, consumer's associated `JetStream` cluster
#[derive(Debug, Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
pub struct ClusterInfo {
/// The cluster name.
#[serde(default)]
pub name: Option<String>,
/// The server name of the RAFT leader.
#[serde(default)]
pub leader: Option<String>,
/// The members of the RAFT cluster.
#[serde(default)]
pub replicas: Vec<PeerInfo>,
}
/// The members of the RAFT cluster
#[derive(Debug, Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
pub struct PeerInfo {
/// The server name of the peer.
pub name: String,
/// Indicates if the server is up to date and synchronised.
pub current: bool,
/// Nanoseconds since this peer was last seen.
#[serde(with = "serde_nanos")]
pub active: Duration,
/// Indicates the node is considered offline by the group.
#[serde(default)]
pub offline: bool,
/// How many uncommitted operations this peer is behind the leader.
pub lag: Option<u64>,
}
/// The response generated by trying ot purge a stream.
#[derive(Debug, Serialize, Deserialize, Clone, Copy)]
pub struct PurgeResponse {
/// Whether the purge request was successful.
pub success: bool,
/// The number of purged messages in a stream.
pub purged: u64,
}
/// The payload used to generate a purge request.
#[derive(Default, Debug, Serialize, Deserialize, Clone)]
pub struct PurgeRequest {
/// Purge up to but not including sequence.
#[serde(default, rename = "seq", skip_serializing_if = "is_default")]
pub sequence: Option<u64>,
/// Subject to match against messages for the purge command.
#[serde(default, skip_serializing_if = "is_default")]
pub filter: Option<String>,
/// Number of messages to keep.
#[serde(default, skip_serializing_if = "is_default")]
pub keep: Option<u64>,
}