Add find_all_extract macro to lightning-invoice

[rust-lightning] / lightning-invoice / src / lib.rs

diff --git a/lightning-invoice/src/lib.rs b/lightning-invoice/src/lib.rs
index 791ff37bf49fae361a29f821b991b1116b7ab126..1d5bb4ffb53e533cb6c06373f8e8803e14b67475 100644 (file)
--- a/lightning-invoice/src/lib.rs
+++ b/lightning-invoice/src/lib.rs
@@ -328,11 +328,16 @@ pub enum Currency {
        /// Bitcoin regtest
        Regtest,
 
-       /// Bitcoin simnet/signet
+       /// Bitcoin simnet
        Simnet,
+
+       /// Bitcoin signet
+       Signet,
 }
 
 /// Tagged field which may have an unknown tag
+///
+/// (C-not exported) as we don't currently support TaggedField
 #[derive(Eq, PartialEq, Debug, Clone)]
 pub enum RawTaggedField {
        /// Parsed tagged field with known tag
@@ -344,6 +349,9 @@ pub enum RawTaggedField {
 /// Tagged field with known tag
 ///
 /// For descriptions of the enum values please refer to the enclosed type's docs.
+///
+/// (C-not exported) As we don't yet support enum variants with the same name the struct contained
+/// in the variant.
 #[allow(missing_docs)]
 #[derive(Eq, PartialEq, Debug, Clone)]
 pub enum TaggedField {
@@ -739,7 +747,7 @@ impl SignedRawInvoice {
 /// Finds the first element of an enum stream of a given variant and extracts one member of the
 /// variant. If no element was found `None` gets returned.
 ///
-/// The following example would extract the first
+/// The following example would extract the first B.
 /// ```
 /// use Enum::*
 ///
@@ -753,11 +761,35 @@ impl SignedRawInvoice {
 /// assert_eq!(find_extract!(elements.iter(), Enum::B(ref x), x), Some(3u16))
 /// ```
 macro_rules! find_extract {
-    ($iter:expr, $enm:pat, $enm_var:ident) => {
+       ($iter:expr, $enm:pat, $enm_var:ident) => {
+               find_all_extract!($iter, $enm, $enm_var).next()
+    };
+}
+
+/// Finds the all elements of an enum stream of a given variant and extracts one member of the
+/// variant through an iterator.
+///
+/// The following example would extract all A.
+/// ```
+/// use Enum::*
+///
+/// enum Enum {
+///    A(u8),
+///    B(u16)
+/// }
+///
+/// let elements = vec![A(1), A(2), B(3), A(4)]
+///
+/// assert_eq!(
+///    find_all_extract!(elements.iter(), Enum::A(ref x), x).collect::<Vec<u8>>(),
+///    vec![1u8, 2u8, 4u8])
+/// ```
+macro_rules! find_all_extract {
+       ($iter:expr, $enm:pat, $enm_var:ident) => {
        $iter.filter_map(|tf| match *tf {
                        $enm => Some($enm_var),
                        _ => None,
-               }).next()
+               })
     };
 }
 
@@ -878,17 +910,11 @@ impl RawInvoice {
 
        /// (C-not exported) as we don't support Vec<&NonOpaqueType>
        pub fn fallbacks(&self) -> Vec<&Fallback> {
-               self.known_tagged_fields().filter_map(|tf| match tf {
-                       &TaggedField::Fallback(ref f) => Some(f),
-                       _ => None,
-               }).collect::<Vec<&Fallback>>()
+               find_all_extract!(self.known_tagged_fields(), TaggedField::Fallback(ref x), x).collect()
        }
 
        pub fn routes(&self) -> Vec<&RouteHint> {
-               self.known_tagged_fields().filter_map(|tf| match tf {
-                       &TaggedField::Route(ref r) => Some(r),
-                       _ => None,
-               }).collect::<Vec<&RouteHint>>()
+               find_all_extract!(self.known_tagged_fields(), TaggedField::Route(ref x), x).collect()
        }
 
        pub fn amount_pico_btc(&self) -> Option<u64> {
@@ -1383,10 +1409,8 @@ impl std::error::Error for SemanticError { }
 
 /// When signing using a fallible method either an user-supplied `SignError` or a `CreationError`
 /// may occur.
-///
-/// (C-not exported) As we don't support unbounded generics
 #[derive(Eq, PartialEq, Debug, Clone)]
-pub enum SignOrCreationError<S> {
+pub enum SignOrCreationError<S = ()> {
        /// An error occurred during signing
        SignError(S),