channel engage_padding_activities: swap docs to tor0proto

This allow us to make a working cross-reference.
This commit is contained in:
Ian Jackson 2022-08-09 11:58:46 +01:00
parent 88dc816770
commit 299f302f35
2 changed files with 13 additions and 11 deletions

View File

@ -46,17 +46,9 @@ pub(crate) trait AbstractChannel: Clone {
/// Specify that this channel should do activities related to channel padding
///
/// Initially, the channel does nothing related to channel padding:
/// it neither sends any padding, nor sends any PADDING_NEGOTIATE cells.
/// See [`Channel::engage_padding_activities`]
///
/// After this function has been called, it will do both,
/// according to the parameters specified through `reparameterize`.
/// Note that this might include *disabling* padding
/// (for example, by sending a `PADDING_NEGOTIATE`).
///
/// Idempotent.
///
/// There is no way to undo the effect of this call.
/// [`Channel::engage_padding_activities`]: tor_proto::channel::Channel::engage_padding_activities
fn engage_padding_activities(&self);
}

View File

@ -421,7 +421,17 @@ impl Channel {
/// Specify that this channel should do activities related to channel padding
///
/// See [`AbstractChannel::set_channel_padding_relevant`]
/// Initially, the channel does nothing related to channel padding:
/// it neither sends any padding, nor sends any PADDING_NEGOTIATE cells.
///
/// After this function has been called, it will do both,
/// according to the parameters specified through `reparameterize`.
/// Note that this might include *disabling* padding
/// (for example, by sending a `PADDING_NEGOTIATE`).
///
/// Idempotent.
///
/// There is no way to undo the effect of this call.
pub fn engage_padding_activities(&self) {
let mut mutable = self.mutable();