Skip to content

Commit

Permalink
docs: add no_inline attribute
Browse files Browse the repository at this point in the history
  • Loading branch information
surban committed Jan 23, 2025
1 parent 5821be9 commit f47908f
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 6 deletions.
3 changes: 2 additions & 1 deletion aggligator-transport-bluer/src/rfcomm.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
//! Bluetooth RFCOMM transport.
use aggligator::io::{IoBox, StreamBox};
use async_trait::async_trait;
use bluer::rfcomm::{Listener, Socket};
use futures::future;
Expand All @@ -16,9 +15,11 @@ use tokio::sync::{mpsc, watch};

use aggligator::{
control::Direction,
io::{IoBox, StreamBox},
transport::{AcceptedStreamBox, AcceptingTransport, ConnectingTransport, LinkTag, LinkTagBox},
};

#[doc(no_inline)]
pub use bluer::{rfcomm::SocketAddr, Address};

static NAME: &str = "rfcomm";
Expand Down
3 changes: 2 additions & 1 deletion aggligator-transport-bluer/src/rfcomm_profile.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
//! Bluetooth RFCOMM transport using profile for connecting.
use aggligator::io::{IoBox, StreamBox};
use async_trait::async_trait;
use bluer::{
agent::{Agent, AgentHandle},
Expand All @@ -19,11 +18,13 @@ use std::{
};
use tokio::sync::{mpsc, watch, Mutex};

#[doc(no_inline)]
pub use bluer::{rfcomm::SocketAddr, Address, Uuid};

use aggligator::{
control::Direction,
exec::time::timeout,
io::{IoBox, StreamBox},
transport::{AcceptedStreamBox, AcceptingTransport, ConnectingTransport, LinkTag, LinkTagBox},
Link,
};
Expand Down
1 change: 1 addition & 0 deletions aggligator-transport-tcp/src/simple.rs
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ mod tls {
};
use aggligator_wrapper_tls::{TlsClient, TlsServer};

#[doc(no_inline)]
pub use aggligator_wrapper_tls::{ClientConfig, RootCertStore, ServerConfig, ServerName};

use crate::{TcpAcceptor, TcpConnector};
Expand Down
4 changes: 3 additions & 1 deletion aggligator-transport-websocket-web/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,11 @@ use std::{
};
use tokio::sync::watch;

pub use websocket_web::{Interface, WebSocketBuilder};
use websocket_web::{WebSocketReceiver, WebSocketSender};

#[doc(no_inline)]
pub use websocket_web::{Interface, WebSocketBuilder};

use aggligator::{
control::Direction,
io::{StreamBox, TxRxBox},
Expand Down
2 changes: 1 addition & 1 deletion aggligator-transport-websocket/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@

//! [Aggligator](aggligator) transport: WebSocket on a native platform (not web).
use aggligator::io::{StreamBox, TxRxBox};
use async_trait::async_trait;
use axum::{
body::Body,
Expand Down Expand Up @@ -40,6 +39,7 @@ use url::Url;

use aggligator::{
control::Direction,
io::{StreamBox, TxRxBox},
transport::{AcceptedStreamBox, AcceptingTransport, ConnectingTransport, LinkTag, LinkTagBox},
Link,
};
Expand Down
7 changes: 5 additions & 2 deletions aggligator-wrapper-tls/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,18 @@
//! This provides connection security by wrapping Aggligator links
//! in TLS.
use aggligator::io::{IoBox, StreamBox};
use async_trait::async_trait;
use std::{io::Result, sync::Arc};
use tokio::io::split;
use tokio_rustls::{TlsAcceptor, TlsConnector};

#[doc(no_inline)]
pub use rustls::{pki_types::ServerName, ClientConfig, RootCertStore, ServerConfig};

use aggligator::transport::{AcceptingWrapper, ConnectingWrapper};
use aggligator::{
io::{IoBox, StreamBox},
transport::{AcceptingWrapper, ConnectingWrapper},
};

static NAME: &str = "tls";

Expand Down

0 comments on commit f47908f

Please sign in to comment.