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 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
//! Common types used across the library. use std::cmp::Ordering; use std::collections::HashMap; use std::time::Duration; use bytes::Bytes; use serde::de::{Deserialize, Visitor}; use serde::ser::Serialize; use uuid::Uuid; use futures::Stream; use serde::{Deserializer, Serializer}; use thiserror::Error; use tonic::Status; /// Represents a reconnection strategy when a connection has dropped or is /// about to be created. #[derive(Copy, Clone, Debug)] pub enum Retry { Undefinately, Only(usize), } /// Holds login and password information. #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] pub struct Credentials { #[serde( serialize_with = "serialize_creds_bytes", deserialize_with = "deserialize_creds_bytes" )] pub(crate) login: Bytes, #[serde( serialize_with = "serialize_creds_bytes", deserialize_with = "deserialize_creds_bytes" )] pub(crate) password: Bytes, } impl Credentials { /// Creates a new `Credentials` instance. pub fn new<S>(login: S, password: S) -> Credentials where S: Into<Bytes>, { Credentials { login: login.into(), password: password.into(), } } } struct CredsVisitor; impl<'de> Visitor<'de> for CredsVisitor { type Value = Bytes; fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { write!(f, "ASCII string") } fn visit_str<E>(self, v: &str) -> std::result::Result<Self::Value, E> where E: serde::de::Error, { Ok(v.to_string().into()) } fn visit_borrowed_str<E>(self, v: &'de str) -> std::result::Result<Self::Value, E> where E: serde::de::Error, { Ok(v.to_string().into()) } fn visit_string<E>(self, v: String) -> std::result::Result<Self::Value, E> where E: serde::de::Error, { Ok(v.into()) } } fn serialize_creds_bytes<S>(value: &Bytes, serializer: S) -> std::result::Result<S::Ok, S::Error> where S: Serializer, { serializer.serialize_bytes(value.as_ref()) } fn deserialize_creds_bytes<'de, D>(deserializer: D) -> std::result::Result<Bytes, D::Error> where D: Deserializer<'de>, { deserializer.deserialize_any(CredsVisitor) } /// Determines whether any link event encountered in the stream will be /// resolved. See the discussion on [Resolved Events](https://eventstore.com/docs/dotnet-api/reading-events/index.html#resolvedevent) /// for more information on this. #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub enum LinkTos { ResolveLink, NoResolution, } impl LinkTos { pub(crate) fn raw_resolve_lnk_tos(self) -> bool { match self { LinkTos::ResolveLink => true, LinkTos::NoResolution => false, } } } /// Constants used for expected version control. /// The use of expected version can be a bit tricky especially when discussing /// assurances given by the GetEventStore server. /// /// The GetEventStore server will assure idempotency for all operations using /// any value in `ExpectedVersion` except `ExpectedVersion::Any`. When using /// `ExpectedVersion::Any`, the GetEventStore server will do its best to assure /// idempotency but will not guarantee idempotency. #[derive(Copy, Clone, Debug)] pub enum ExpectedVersion { /// This write should not conflict with anything and should always succeed. Any, /// The stream should exist. If it or a metadata stream does not exist, /// treats that as a concurrency problem. StreamExists, /// The stream being written to should not yet exist. If it does exist, /// treats that as a concurrency problem. NoStream, /// States that the last event written to the stream should have an event /// number matching your expected value. Exact(u64), } /// A structure referring to a potential logical record position in the /// EventStoreDB transaction file. #[derive(Debug, Copy, Clone, PartialEq, Eq)] pub struct Position { /// Commit position of the record. pub commit: u64, /// Prepare position of the record. pub prepare: u64, } impl Position { /// Points to the begin of the transaction file. pub fn start() -> Self { Position { commit: 0, prepare: 0, } } /// Points to the end of the transaction file. pub fn end() -> Self { Position { commit: u64::MAX, prepare: u64::MAX, } } } impl PartialOrd for Position { fn partial_cmp(&self, other: &Position) -> Option<Ordering> { Some(self.cmp(other)) } } impl Ord for Position { fn cmp(&self, other: &Position) -> Ordering { self.commit .cmp(&other.commit) .then(self.prepare.cmp(&other.prepare)) } } /// Returned after writing to a stream. #[derive(Debug)] pub struct WriteResult { /// Next expected version of the stream. pub next_expected_version: u64, /// `Position` of the write. pub position: Position, } #[derive(Debug)] pub enum Revision<A> { Start, End, Exact(A), } /// Enumeration detailing the possible outcomes of reading a stream. #[derive(Debug)] pub enum ReadEventStatus<A> { NotFound, NoStream, Deleted, Success(A), } /// Represents the result of looking up a specific event number from a stream. #[derive(Debug)] pub struct ReadEventResult { /// Stream where the event orignates from. pub stream_id: String, /// Sequence number of the event. pub event_number: i64, /// Event data. pub event: ResolvedEvent, } /// Represents a previously written event. #[derive(Debug)] pub struct RecordedEvent { /// The event stream that events belongs to. pub stream_id: String, /// Unique identifier representing this event. pub id: Uuid, /// Number of this event in the stream. pub revision: u64, /// Type of this event. pub event_type: String, /// Payload of this event. pub data: Bytes, /// Representing the metadata associated with this event. pub metadata: HashMap<String, String>, /// Representing the user-defined metadata associated with this event. pub custom_metadata: Bytes, /// Indicates wheter the content is internally marked as JSON. pub is_json: bool, /// An event position in the $all stream. pub position: Position, } impl RecordedEvent { /// Tries to decode this event payload as a JSON object. pub fn as_json<'a, T>(&'a self) -> serde_json::Result<T> where T: Deserialize<'a>, { serde_json::from_slice(&self.data[..]) } } /// A structure representing a single event or an resolved link event. #[derive(Debug)] pub struct ResolvedEvent { /// The event, or the resolved link event if this `ResolvedEvent` is a link /// event. pub event: Option<RecordedEvent>, /// The link event if this `ResolvedEvent` is a link event. pub link: Option<RecordedEvent>, pub commit_position: Option<u64>, } impl ResolvedEvent { /// If it's a link event with its associated resolved event. pub fn is_resolved(&self) -> bool { self.event.is_some() && self.link.is_some() } /// Returns the event that was read or which triggered the subscription. /// If this `ResolvedEvent` represents a link event, the link will be the /// original event, otherwise it will be the event. /// pub fn get_original_event(&self) -> &RecordedEvent { self.link.as_ref().unwrap_or_else(|| { self.event .as_ref() .expect("[get_original_event] Not supposed to happen!") }) } /// Returns the stream id of the original event. pub fn get_original_stream_id(&self) -> &str { let event = self.get_original_event(); &event.stream_id } } /// Represents stream metadata as a series of properties for system data and /// user-defined metadata. #[derive(Debug, Clone)] pub enum StreamMetadataResult { Deleted { stream: String }, NotFound { stream: String }, Success(Box<VersionedMetadata>), } /// Represents a stream metadata. #[derive(Debug, Clone)] pub struct VersionedMetadata { /// Metadata's stream. pub stream: String, /// Metadata's version. pub version: i64, /// Metadata properties. pub metadata: StreamMetadata, } /// Represents the direction of read operation (both from '$all' and a regular /// stream). #[derive(Copy, Clone, Debug)] pub enum ReadDirection { Forward, Backward, } /// Represents the errors that can arise when reading a stream. #[derive(Debug, Clone)] pub enum ReadStreamError { NoStream(String), StreamDeleted(String), NotModified(String), Error(String), AccessDenied(String), } /// Represents the result of reading a stream. #[derive(Debug, Clone)] pub enum ReadStreamStatus<A> { Success(A), Error(ReadStreamError), } pub enum Payload { Json(Bytes), Binary(Bytes), } impl Payload { pub fn is_json(&self) -> bool { matches!(*self, Payload::Json(_)) } pub fn into_inner(self) -> Bytes { match self { Payload::Json(bytes) => bytes, Payload::Binary(bytes) => bytes, } } } /// Holds data of event about to be sent to the server. pub struct EventData { pub(crate) event_type: String, pub(crate) payload: Payload, pub(crate) id_opt: Option<Uuid>, pub(crate) custom_metadata: Option<Payload>, } impl EventData { /// Creates an event with a JSON payload. pub fn json<S, P>(event_type: S, payload: P) -> serde_json::Result<EventData> where P: Serialize, S: AsRef<str>, { let payload = serde_json::to_vec(&payload)?; let payload = Bytes::from(payload); let payload = Payload::Json(payload); Ok(EventData { event_type: event_type.as_ref().to_string(), payload, id_opt: None, custom_metadata: None, }) } /// Creates an event with a raw binary payload. pub fn binary<S>(event_type: S, payload: Bytes) -> Self where S: AsRef<str>, { EventData { event_type: event_type.as_ref().to_string(), payload: Payload::Binary(payload), id_opt: None, custom_metadata: None, } } /// Set an id to this event. By default, the id will be generated by the /// server. pub fn id(self, value: Uuid) -> Self { EventData { id_opt: Some(value), ..self } } /// Assigns a JSON metadata to this event. pub fn metadata_as_json<P>(self, payload: P) -> EventData where P: Serialize, { let bytes = Bytes::from(serde_json::to_vec(&payload).unwrap()); let json_bin = Some(Payload::Json(bytes)); EventData { custom_metadata: json_bin, ..self } } /// Assigns a raw binary metadata to this event. pub fn metadata_as_binary(self, payload: Bytes) -> EventData { let content_bin = Some(Payload::Binary(payload)); EventData { custom_metadata: content_bin, ..self } } } /// Used to facilitate the creation of a stream's metadata. #[derive(Default)] pub struct StreamMetadataBuilder { max_count: Option<u64>, max_age: Option<Duration>, truncate_before: Option<u64>, cache_control: Option<Duration>, acl: Option<StreamAcl>, properties: HashMap<String, serde_json::Value>, } impl StreamMetadataBuilder { /// Creates a `StreamMetadata` initialized with default values. pub fn new() -> StreamMetadataBuilder { Default::default() } /// Sets a sliding window based on the number of items in the stream. /// When data reaches a certain length it disappears automatically /// from the stream and is considered eligible for scavenging. pub fn max_count(self, value: u64) -> StreamMetadataBuilder { StreamMetadataBuilder { max_count: Some(value), ..self } } /// Sets a sliding window based on dates. When data reaches a certain age /// it disappears automatically from the stream and is considered /// eligible for scavenging. pub fn max_age(self, value: Duration) -> StreamMetadataBuilder { StreamMetadataBuilder { max_age: Some(value), ..self } } /// Sets the event number from which previous events can be scavenged. pub fn truncate_before(self, value: u64) -> StreamMetadataBuilder { StreamMetadataBuilder { truncate_before: Some(value), ..self } } /// This controls the cache of the head of a stream. Most URIs in a stream /// are infinitely cacheable but the head by default will not cache. It /// may be preferable in some situations to set a small amount of caching /// on the head to allow intermediaries to handle polls (say 10 seconds). pub fn cache_control(self, value: Duration) -> StreamMetadataBuilder { StreamMetadataBuilder { cache_control: Some(value), ..self } } /// Sets the ACL of a stream. pub fn acl(self, value: StreamAcl) -> StreamMetadataBuilder { StreamMetadataBuilder { acl: Some(value), ..self } } /// Adds user-defined property in the stream metadata. pub fn insert_custom_property<V>(mut self, key: String, value: V) -> StreamMetadataBuilder where V: Serialize, { let serialized = serde_json::to_value(value).unwrap(); let _ = self.properties.insert(key, serialized); self } /// Returns a properly configured `StreamMetaData`. pub fn build(self) -> StreamMetadata { StreamMetadata { max_count: self.max_count, max_age: self.max_age, truncate_before: self.truncate_before, cache_control: self.cache_control, acl: self.acl.unwrap_or_default(), custom_properties: self.properties, } } } /// Represents stream metadata with strongly types properties for system values /// and a dictionary-like interface for custom values. #[derive(Debug, Default, Clone)] pub struct StreamMetadata { /// A sliding window based on the number of items in the stream. When data reaches /// a certain length it disappears automatically from the stream and is considered /// eligible for scavenging. pub max_count: Option<u64>, /// A sliding window based on dates. When data reaches a certain age it disappears /// automatically from the stream and is considered eligible for scavenging. pub max_age: Option<Duration>, /// The event number from which previous events can be scavenged. This is /// used to implement soft-deletion of streams. pub truncate_before: Option<u64>, /// Controls the cache of the head of a stream. Most URIs in a stream are infinitely /// cacheable but the head by default will not cache. It may be preferable /// in some situations to set a small amount of caching on the head to allow /// intermediaries to handle polls (say 10 seconds). pub cache_control: Option<Duration>, /// The access control list for the stream. pub acl: StreamAcl, /// An enumerable of key-value pairs of keys to JSON value for /// user-provided metadata. pub custom_properties: HashMap<String, serde_json::Value>, } impl StreamMetadata { /// Initializes a fresh stream metadata builder. pub fn builder() -> StreamMetadataBuilder { StreamMetadataBuilder::new() } } /// Represents an access control list for a stream. #[derive(Default, Debug, Clone)] pub struct StreamAcl { /// Roles and users permitted to read the stream. pub read_roles: Option<Vec<String>>, /// Roles and users permitted to write to the stream. pub write_roles: Option<Vec<String>>, /// Roles and users permitted to delete to the stream. pub delete_roles: Option<Vec<String>>, /// Roles and users permitted to read stream metadata. pub meta_read_roles: Option<Vec<String>>, /// Roles and users permitted to write stream metadata. pub meta_write_roles: Option<Vec<String>>, } /// Read part of a persistent subscription, isomorphic to a stream of events. pub struct PersistentSubRead { pub(crate) inner: Box<dyn Stream<Item = PersistentSubEvent> + Send + Unpin>, } impl PersistentSubRead { pub fn into_inner(self) -> Box<dyn Stream<Item = PersistentSubEvent> + Send + Unpin> { self.inner } pub async fn read_next(&mut self) -> Option<PersistentSubEvent> { use futures::stream::StreamExt; self.inner.next().await } } /// Events related to a subscription. pub enum SubEvent { /// Indicates the subscription has been confirmed by the server. Confirmed, /// An event notification from the server. EventAppeared { event: Box<ResolvedEvent>, retry_count: usize, }, /// Indicates the subscription has dropped. Dropped, } #[derive(Debug)] pub struct PersistentSubEvent { pub inner: ResolvedEvent, pub retry_count: usize, } /// Gathers every possible Nak actions. #[derive(Debug, PartialEq, Eq)] pub enum NakAction { /// Client unknown on action. Let server decide. Unknown, /// Park message do not resend. Put on poison queue. Park, /// Explicity retry the message. Retry, /// Skip this message do not resend do not put in poison queue. Skip, /// Stop the subscription. Stop, } /// System supported consumer strategies for use with persistent subscriptions. #[derive(Copy, Clone, PartialEq, Eq, Debug)] pub enum SystemConsumerStrategy { /// Distributes events to a single client until the bufferSize is reached. /// After which the next client is selected in a round robin style, /// and the process is repeated. DispatchToSingle, /// Distributes events to all clients evenly. If the client buffer-size /// is reached the client is ignored until events are /// acknowledged/not acknowledged. RoundRobin, /// For use with an indexing projection such as the system $by_category /// projection. Event Store inspects event for its source stream id, /// hashing the id to one of 1024 buckets assigned to individual clients. /// When a client disconnects it's buckets are assigned to other clients. /// When a client connects, it is assigned some of the existing buckets. /// This naively attempts to maintain a balanced workload. /// The main aim of this strategy is to decrease the likelihood of /// concurrency and ordering issues while maintaining load balancing. /// This is not a guarantee, and you should handle the usual ordering /// and concurrency issues. Pinned, } /// Gathers every persistent subscription property. #[derive(Debug, Clone, Copy)] pub struct PersistentSubscriptionSettings { /// Whether or not the persistent subscription shoud resolve 'linkTo' /// events to their linked events. pub resolve_links: bool, /// Where the subscription should start from (event number). pub revision: u64, /// Whether or not in depth latency statistics should be tracked on this /// subscription. pub extra_stats: bool, /// The amount of time after which a message should be considered to be /// timeout and retried. pub message_timeout: Duration, /// The maximum number of retries (due to timeout) before a message get /// considered to be parked. pub max_retry_count: i32, /// The size of the buffer listenning to live messages as they happen. pub live_buffer_size: i32, /// The number of events read at a time when paging in history. pub read_batch_size: i32, /// The number of events to cache when paging through history. pub history_buffer_size: i32, /// The amount of time to try checkpoint after. pub checkpoint_after: Duration, /// The minimum number of messages to checkpoint. pub min_checkpoint_count: i32, /// The maximum number of messages to checkpoint. If this number is reached /// , a checkpoint will be forced. pub max_checkpoint_count: i32, /// The maximum number of subscribers allowed. pub max_subscriber_count: i32, /// The strategy to use for distributing events to client consumers. pub named_consumer_strategy: SystemConsumerStrategy, } impl PersistentSubscriptionSettings { pub fn default() -> PersistentSubscriptionSettings { PersistentSubscriptionSettings { resolve_links: false, revision: 0, extra_stats: false, message_timeout: Duration::from_secs(30), max_retry_count: 10, live_buffer_size: 500, read_batch_size: 20, history_buffer_size: 500, checkpoint_after: Duration::from_secs(2), min_checkpoint_count: 10, max_checkpoint_count: 1_000, max_subscriber_count: 0, // Means their is no limit. named_consumer_strategy: SystemConsumerStrategy::RoundRobin, } } } impl Default for PersistentSubscriptionSettings { fn default() -> PersistentSubscriptionSettings { PersistentSubscriptionSettings::default() } } /// Represents the different scenarios that could happen when performing /// a persistent subscription. #[derive(Debug, Eq, PartialEq)] pub enum PersistActionResult { Success, Failure(PersistActionError), } impl PersistActionResult { /// Checks if the persistent action succeeded. pub fn is_success(&self) -> bool { matches!(*self, PersistActionResult::Success) } /// Checks if the persistent action failed. pub fn is_failure(&self) -> bool { !self.is_success() } } /// Enumerates all persistent action exceptions. #[derive(Debug, Eq, PartialEq)] pub enum PersistActionError { /// The action failed. Fail, /// Happens when creating a persistent subscription on a stream with a /// group name already taken. AlreadyExists, /// An operation tried to do something on a persistent subscription or a /// stream that don't exist. DoesNotExist, /// The current user is not allowed to operate on the supplied stream or /// persistent subscription. AccessDenied, } /// Indicates which order of preferred nodes for connecting to. #[derive(Copy, Clone, Eq, PartialEq, Debug, Serialize, Deserialize)] pub enum NodePreference { /// When attempting connection, prefers leader nodes. Leader, /// When attempting connection, prefers follower nodes. Follower, /// When attempting connection, has no node preference. Random, /// When attempting connection, prefers read-replica nodes. ReadOnlyReplica, } impl Default for NodePreference { fn default() -> Self { NodePreference::Random } } impl std::fmt::Display for NodePreference { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { use self::NodePreference::*; match self { Leader => write!(f, "Leader"), Follower => write!(f, "Follower"), Random => write!(f, "Random"), ReadOnlyReplica => write!(f, "ReadOnlyReplica"), } } } #[derive(Debug)] pub(crate) enum Either<A, B> { Left(A), Right(B), } impl<A, B> Either<A, B> { pub(crate) fn as_ref(&self) -> Either<&A, &B> { match self { Either::Left(a) => Either::Left(&a), Either::Right(b) => Either::Right(&b), } } } #[derive(Debug)] pub(crate) struct DnsClusterSettings { pub(crate) resolver: trust_dns_resolver::TokioAsyncResolver, pub(crate) domain_name: trust_dns_resolver::Name, pub(crate) gossip_port: u32, pub(crate) lookup: LookupType, } #[derive(PartialEq, Eq, Serialize, Deserialize, Debug, Clone, Copy)] pub(crate) enum LookupType { #[serde(rename = "a")] LookupA, #[serde(rename = "srv")] LookupSRV, } impl Default for LookupType { fn default() -> Self { LookupType::LookupA } } #[derive(Copy, Clone, Eq, PartialEq, Debug)] /// Actual revision of a stream. pub enum CurrentRevision { /// The last event's number. Current(u64), /// The stream doesn't exist. NoStream, } #[derive(Copy, Clone, Eq, PartialEq, Debug)] /// Expected revision before a write occurs. pub enum ExpectedRevision { /// States that the last event written to the stream should have an event number matching your /// expected value. Expected(u64), /// You expected that write should not conflict with anything and should always succeed. Any, /// You expected the stream should exist. StreamExists, } #[derive(Clone, Debug, Copy, Eq, PartialEq)] pub struct WrongExpectedVersion { pub current: CurrentRevision, pub expected: ExpectedRevision, } impl std::fmt::Display for WrongExpectedVersion { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { write!( f, "WrongExpectedVersion: expected: {:?}, got: {:?}", self.expected, self.current ) } } impl std::error::Error for WrongExpectedVersion {} #[derive(Debug, Clone, Eq, Ord, PartialOrd, PartialEq, Serialize, Deserialize)] pub struct Endpoint { pub host: String, pub port: u32, } #[derive(Error, Debug)] /// EventStoreDB command error. pub enum Error { #[error("Server-side error.")] ServerError, #[error("You tried to execute a command that requires a leader node on a follower node. New leader: ")] NotLeaderException(Endpoint), #[error("Connection is closed.")] ConnectionClosed, #[error("Unmapped gRPC error: {0}.")] Grpc(Status), } impl Error { pub fn from_grpc(status: Status) -> Self { match status.code() { tonic::Code::Unavailable => Error::ServerError, _ => { let metadata = status.metadata(); if let Some(tpe) = metadata.get("exception").and_then(|e| e.to_str().ok()) { if let "not-leader" = tpe { let endpoint = metadata .get("leader-endpoint-host") .zip(metadata.get("leader-endpoint-port")) .and_then(|(host, port)| { let host = host.to_str().ok()?; let port = port.to_str().ok()?; let host = host.to_string(); let port = port.parse().ok()?; Some(Endpoint { host, port }) }); if let Some(leader) = endpoint { return Error::NotLeaderException(leader); } } } Error::Grpc(status) } } } } pub type Result<A> = std::result::Result<A, Error>; #[derive(Clone, Debug, PartialEq, Eq)] pub enum ReadResult<A> { Ok(A), StreamNotFound(String), } impl<A> ReadResult<A> { /// Maps an `ReadResult<A>` to `ReadResult<B>` by applying a function to a contained value. pub fn map<B, F>(self, f: F) -> ReadResult<B> where F: FnOnce(A) -> B, { match self { ReadResult::Ok(a) => ReadResult::Ok(f(a)), ReadResult::StreamNotFound(s) => ReadResult::StreamNotFound(s), } } /// Converts from `ReadResult<A>` to [`Option<A>`]. /// /// Converts `self` into an [`Option<A>`], consuming `self`, /// and discarding the success value, if any. /// /// [`Option<A>`]: Option pub fn ok(self) -> Option<A> { match self { ReadResult::Ok(a) => Some(a), ReadResult::StreamNotFound(_) => None, } } /// Returns `true` if the result is [`ReadResult::Ok`]. pub const fn is_ok(&self) -> bool { matches!(*self, ReadResult::Ok(_)) } /// Returns `true` if the result is [`ReadResult::StreamNotFound`]. pub const fn is_not_found(&self) -> bool { !self.is_ok() } /// Returns the contained [`Ok`] value, consuming the `self` value. #[inline] #[track_caller] pub fn unwrap(self) -> A { match self { ReadResult::Ok(a) => a, ReadResult::StreamNotFound(s) => panic!( "called `ReadResult::unwrap()` on an `StreamNotFound({})` value", &s ), } } }