From: Matt Corallo Date: Mon, 26 Aug 2024 18:28:07 +0000 (+0000) Subject: Mark new `types` `#[doc(hidden)]` methods as bindings no-export X-Git-Tag: v0.0.124-rc1~10^2~1 X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=72246648102552b0e1565bf3e8e442273ff174e1;p=rust-lightning Mark new `types` `#[doc(hidden)]` methods as bindings no-export --- diff --git a/lightning-types/src/features.rs b/lightning-types/src/features.rs index 54587dc98..a3cb9db2f 100644 --- a/lightning-types/src/features.rs +++ b/lightning-types/src/features.rs @@ -703,6 +703,8 @@ impl InitFeatures { #[doc(hidden)] /// Converts `InitFeatures` to `Features`. Only known `InitFeatures` relevant to context `C` /// are included in the result. + /// + /// This is not exported to bindings users as it shouldn't be used outside of LDK pub fn to_context(&self) -> Features { self.to_context_internal() } @@ -712,6 +714,8 @@ impl Bolt11InvoiceFeatures { #[doc(hidden)] /// Converts `Bolt11InvoiceFeatures` to `Features`. Only known `Bolt11InvoiceFeatures` relevant to /// context `C` are included in the result. + /// + /// This is not exported to bindings users as it shouldn't be used outside of LDK pub fn to_context(&self) -> Features { self.to_context_internal() } @@ -737,6 +741,8 @@ impl Bolt12InvoiceFeatures { #[doc(hidden)] /// Converts [`Bolt12InvoiceFeatures`] to [`Features`]. Only known [`Bolt12InvoiceFeatures`] /// relevant to context `C` are included in the result. + /// + /// This is not exported to bindings users as it shouldn't be used outside of LDK pub fn to_context(&self) -> Features { self.to_context_internal() } @@ -744,8 +750,10 @@ impl Bolt12InvoiceFeatures { impl ChannelTypeFeatures { #[doc(hidden)] - // Maps the relevant `InitFeatures` to `ChannelTypeFeatures`. Any unknown features to - // `ChannelTypeFeatures` are not included in the result. + /// Maps the relevant `InitFeatures` to `ChannelTypeFeatures`. Any unknown features to + /// `ChannelTypeFeatures` are not included in the result. + /// + /// This is not exported to bindings users as it shouldn't be used outside of LDK pub fn from_init(init: &InitFeatures) -> Self { let mut ret = init.to_context_internal(); // ChannelTypeFeatures must only contain required bits, so we OR the required forms of all