mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-25 07:17:40 +01:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #3272 from TheBlueMatt/2024-08-bindings-hidden

Browse source 
Mark new `types` `#[doc(hidden)]` methods as bindings no-export
This commit is contained in:
Matt Corallo 2024-08-26 23:44:14 +00:00 • committed by GitHub
commit 9effe0aa74
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 13 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
lightning-types/src/features.rs
View file

@ -703,6 +703,8 @@ impl InitFeatures {
#[doc(hidden)] #[doc(hidden)]
/// Converts `InitFeatures` to `Features<C>`. Only known `InitFeatures` relevant to context `C` /// Converts `InitFeatures` to `Features<C>`. Only known `InitFeatures` relevant to context `C`
/// are included in the result. /// 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<C: sealed::Context>(&self) -> Features<C> { pub fn to_context<C: sealed::Context>(&self) -> Features<C> {
self.to_context_internal() self.to_context_internal()
} }
@ -712,6 +714,8 @@ impl Bolt11InvoiceFeatures {
#[doc(hidden)] #[doc(hidden)]
/// Converts `Bolt11InvoiceFeatures` to `Features<C>`. Only known `Bolt11InvoiceFeatures` relevant to /// Converts `Bolt11InvoiceFeatures` to `Features<C>`. Only known `Bolt11InvoiceFeatures` relevant to
/// context `C` are included in the result. /// 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<C: sealed::Context>(&self) -> Features<C> { pub fn to_context<C: sealed::Context>(&self) -> Features<C> {
self.to_context_internal() self.to_context_internal()
} }
@ -737,6 +741,8 @@ impl Bolt12InvoiceFeatures {
#[doc(hidden)] #[doc(hidden)]
/// Converts [`Bolt12InvoiceFeatures`] to [`Features<C>`]. Only known [`Bolt12InvoiceFeatures`] /// Converts [`Bolt12InvoiceFeatures`] to [`Features<C>`]. Only known [`Bolt12InvoiceFeatures`]
/// relevant to context `C` are included in the result. /// 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<C: sealed::Context>(&self) -> Features<C> { pub fn to_context<C: sealed::Context>(&self) -> Features<C> {
self.to_context_internal() self.to_context_internal()
} }
@ -744,8 +750,10 @@ impl Bolt12InvoiceFeatures {
impl ChannelTypeFeatures { impl ChannelTypeFeatures {
#[doc(hidden)] #[doc(hidden)]
// Maps the relevant `InitFeatures` to `ChannelTypeFeatures`. Any unknown features to /// Maps the relevant `InitFeatures` to `ChannelTypeFeatures`. Any unknown features to
// `ChannelTypeFeatures` are not included in the result. /// `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 { pub fn from_init(init: &InitFeatures) -> Self {
let mut ret = init.to_context_internal(); let mut ret = init.to_context_internal();
// ChannelTypeFeatures must only contain required bits, so we OR the required forms of all // ChannelTypeFeatures must only contain required bits, so we OR the required forms of all

3
lightning/src/io/mod.rs
View file

@ -1,6 +1,9 @@
pub use bitcoin::io::*; pub use bitcoin::io::*;
/// Emulation of std::io::Cursor /// Emulation of std::io::Cursor
///
/// This is not exported to bindings users as serialization is done via a bindings-specific
/// pipeline.
#[derive(Clone, Debug, Default, Eq, PartialEq)] #[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct Cursor<T> { pub struct Cursor<T> {
inner: T, inner: T,