@@ -216,7 +216,7 @@ pub const DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA: u64 = 18;
216216/// * `H`: exactly one `PaymentHash`
217217/// * `T`: the timestamp is set
218218///
219- /// (C- not exported) as we likely need to manually select one set of boolean type parameters.
219+ /// This is not exported to bindings users as we likely need to manually select one set of boolean type parameters.
220220#[ derive( Eq , PartialEq , Debug , Clone ) ]
221221pub struct InvoiceBuilder < D : tb:: Bool , H : tb:: Bool , T : tb:: Bool , C : tb:: Bool , S : tb:: Bool > {
222222 currency : Currency ,
@@ -247,7 +247,7 @@ pub struct Invoice {
247247/// Represents the description of an invoice which has to be either a directly included string or
248248/// a hash of a description provided out of band.
249249///
250- /// (C- not exported) As we don't have a good way to map the reference lifetimes making this
250+ /// This is not exported to bindings users as we don't have a good way to map the reference lifetimes making this
251251/// practically impossible to use safely in languages like C.
252252#[ derive( Eq , PartialEq , Debug , Clone ) ]
253253pub enum InvoiceDescription < ' f > {
@@ -297,7 +297,7 @@ pub struct RawInvoice {
297297
298298/// Data of the `RawInvoice` that is encoded in the human readable part
299299///
300- /// (C- not exported) As we don't yet support `Option<Enum>`
300+ /// This is not exported to bindings users as we don't yet support `Option<Enum>`
301301#[ derive( Eq , PartialEq , Debug , Clone , Hash ) ]
302302pub struct RawHrp {
303303 /// The currency deferred from the 3rd and 4th character of the bech32 transaction
@@ -357,7 +357,7 @@ impl SiPrefix {
357357 /// Returns all enum variants of `SiPrefix` sorted in descending order of their associated
358358 /// multiplier.
359359 ///
360- /// (C- not exported) As we don't yet support a slice of enums, and also because this function
360+ /// This is not exported to bindings users as we don't yet support a slice of enums, and also because this function
361361 /// isn't the most critical to expose.
362362 pub fn values_desc ( ) -> & ' static [ SiPrefix ] {
363363 use crate :: SiPrefix :: * ;
@@ -387,7 +387,7 @@ pub enum Currency {
387387
388388/// Tagged field which may have an unknown tag
389389///
390- /// (C- not exported) as we don't currently support TaggedField
390+ /// This is not exported to bindings users as we don't currently support TaggedField
391391#[ derive( Clone , Debug , Hash , Eq , PartialEq ) ]
392392pub enum RawTaggedField {
393393 /// Parsed tagged field with known tag
@@ -400,7 +400,7 @@ pub enum RawTaggedField {
400400///
401401/// For descriptions of the enum values please refer to the enclosed type's docs.
402402///
403- /// (C- not exported) As we don't yet support enum variants with the same name the struct contained
403+ /// This is not exported to bindings users as we don't yet support enum variants with the same name the struct contained
404404/// in the variant.
405405#[ allow( missing_docs) ]
406406#[ derive( Clone , Debug , Hash , Eq , PartialEq ) ]
@@ -419,7 +419,7 @@ pub enum TaggedField {
419419
420420/// SHA-256 hash
421421#[ derive( Clone , Debug , Hash , Eq , PartialEq ) ]
422- pub struct Sha256 ( /// (C- not exported) as the native hash types are not currently mapped
422+ pub struct Sha256 ( /// This is not exported to bindings users as the native hash types are not currently mapped
423423 pub sha256:: Hash ) ;
424424
425425/// Description string
@@ -885,7 +885,7 @@ impl RawInvoice {
885885 /// of type `E`. Since the signature of a `SignedRawInvoice` is not required to be valid there
886886 /// are no constraints regarding the validity of the produced signature.
887887 ///
888- /// (C- not exported) As we don't currently support passing function pointers into methods
888+ /// This is not exported to bindings users as we don't currently support passing function pointers into methods
889889 /// explicitly.
890890 pub fn sign < F , E > ( self , sign_method : F ) -> Result < SignedRawInvoice , E >
891891 where F : FnOnce ( & Message ) -> Result < RecoverableSignature , E >
@@ -904,7 +904,7 @@ impl RawInvoice {
904904
905905 /// Returns an iterator over all tagged fields with known semantics.
906906 ///
907- /// (C- not exported) As there is not yet a manual mapping for a FilterMap
907+ /// This is not exported to bindings users as there is not yet a manual mapping for a FilterMap
908908 pub fn known_tagged_fields ( & self )
909909 -> FilterMap < Iter < RawTaggedField > , fn ( & RawTaggedField ) -> Option < & TaggedField > >
910910 {
@@ -953,7 +953,7 @@ impl RawInvoice {
953953 find_extract ! ( self . known_tagged_fields( ) , TaggedField :: Features ( ref x) , x)
954954 }
955955
956- /// (C- not exported) as we don't support Vec<&NonOpaqueType>
956+ /// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
957957 pub fn fallbacks ( & self ) -> Vec < & Fallback > {
958958 find_all_extract ! ( self . known_tagged_fields( ) , TaggedField :: Fallback ( ref x) , x) . collect ( )
959959 }
@@ -1182,7 +1182,7 @@ impl Invoice {
11821182
11831183 /// Returns an iterator over all tagged fields of this Invoice.
11841184 ///
1185- /// (C- not exported) As there is not yet a manual mapping for a FilterMap
1185+ /// This is not exported to bindings users as there is not yet a manual mapping for a FilterMap
11861186 pub fn tagged_fields ( & self )
11871187 -> FilterMap < Iter < RawTaggedField > , fn ( & RawTaggedField ) -> Option < & TaggedField > > {
11881188 self . signed_invoice . raw_invoice ( ) . known_tagged_fields ( )
@@ -1195,7 +1195,7 @@ impl Invoice {
11951195
11961196 /// Return the description or a hash of it for longer ones
11971197 ///
1198- /// (C- not exported) because we don't yet export InvoiceDescription
1198+ /// This is not exported to bindings users because we don't yet export InvoiceDescription
11991199 pub fn description ( & self ) -> InvoiceDescription {
12001200 if let Some ( direct) = self . signed_invoice . description ( ) {
12011201 return InvoiceDescription :: Direct ( direct) ;
@@ -1265,7 +1265,7 @@ impl Invoice {
12651265
12661266 /// Returns a list of all fallback addresses
12671267 ///
1268- /// (C- not exported) as we don't support Vec<&NonOpaqueType>
1268+ /// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
12691269 pub fn fallbacks ( & self ) -> Vec < & Fallback > {
12701270 self . signed_invoice . fallbacks ( )
12711271 }
0 commit comments