Skip to content

docs: fixed internal links #428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Scarjit wants to merge 2 commits into from
Closed

docs: fixed internal links #428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
909e24a
docs: fixed internal links
Scarjit Feb 14, 2022
db50816
docs: fixed internal link in pem-rfc7468
Scarjit Feb 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion base64ct/src/decoder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ const CHAR_LF: u8 = 0x0a;
/// Stateful Base64 decoder with support for buffered, incremental decoding.
///
/// The `E` type parameter can be any type which impls [`Encoding`] such as
/// [`Base64`] or [`Base64Unpadded`].
/// [Base64][`crate::variant::standard::Base64`] or [Base64Unpadded][`crate::variant::standard::Base64Unpadded`].
Copy link
Member

@tarcieri tarcieri Feb 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check line 17 of this file. There are imports of these, although they should probably be gated on #[cfg(doc)] instead of #[cfg(docsrs)].

///
/// Internally it uses a sealed `Variant` trait which is an implementation
/// detail of this crate, and leverages a [blanket impl] of [`Encoding`].
Expand Down
2 changes: 1 addition & 1 deletion base64ct/src/encoder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use crate::{Base64, Base64Unpadded};
/// Stateful Base64 encoder with support for buffered, incremental encoding.
///
/// The `E` type parameter can be any type which impls [`Encoding`] such as
/// [`Base64`] or [`Base64Unpadded`].
/// [Base64][`crate::variant::standard::Base64`] or [Base64Unpadded][`crate::variant::standard::Base64Unpadded`].
Copy link
Member

@tarcieri tarcieri Feb 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likewise here. Line 10.

///
/// Internally it uses a sealed `Variant` trait which is an implementation
/// detail of this crate, and leverages a [blanket impl] of [`Encoding`].
Expand Down
2 changes: 1 addition & 1 deletion pem-rfc7468/src/decoder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ impl<'i> Decoder<'i> {
self.base64.is_finished()
}

/// Convert into the inner [`base64::Decoder`].
/// Convert into the inner [Base64Decoder][`crate::Base64Decoder`].
pub fn into_base64_decoder(self) -> Base64Decoder<'i> {
self.base64
}
Expand Down
16 changes: 8 additions & 8 deletions pkcs1/src/traits.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ use der::Document;
#[cfg(feature = "pem")]
use zeroize::Zeroizing;

/// Parse an [`RsaPrivateKey`] from a PKCS#1-encoded document.
/// Parse an [RsaPrivateKey][`crate::private_key::RsaPrivateKey`] from a PKCS#1-encoded document.
pub trait DecodeRsaPrivateKey: Sized {
/// Deserialize PKCS#1 private key from ASN.1 DER-encoded data
/// (binary format).
Expand Down Expand Up @@ -58,13 +58,13 @@ pub trait DecodeRsaPrivateKey: Sized {
}
}

/// Parse a [`RsaPublicKey`] from a PKCS#1-encoded document.
/// Parse a [RsaPublicKey][`crate::public_key::RsaPublicKey`] from a PKCS#1-encoded document.
pub trait DecodeRsaPublicKey: Sized {
/// Deserialize object from ASN.1 DER-encoded [`RsaPublicKey`]
/// Deserialize object from ASN.1 DER-encoded [RsaPublicKey][`crate::public_key::RsaPublicKey`]
/// (binary format).
fn from_pkcs1_der(bytes: &[u8]) -> Result<Self>;

/// Deserialize PEM-encoded [`RsaPublicKey`].
/// Deserialize PEM-encoded [RsaPublicKey][`crate::public_key::RsaPublicKey`].
///
/// Keys in this format begin with the following:
///
Expand All @@ -77,7 +77,7 @@ pub trait DecodeRsaPublicKey: Sized {
RsaPublicKeyDocument::from_pkcs1_pem(s).and_then(|doc| Self::from_pkcs1_der(doc.as_der()))
}

/// Load [`RsaPublicKey`] from an ASN.1 DER-encoded file on the local
/// Load [RsaPublicKey][`crate::public_key::RsaPublicKey`] from an ASN.1 DER-encoded file on the local
/// filesystem (binary format).
#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
Expand All @@ -86,7 +86,7 @@ pub trait DecodeRsaPublicKey: Sized {
.and_then(|doc| Self::from_pkcs1_der(doc.as_der()))
}

/// Load [`RsaPublicKey`] from a PEM-encoded file on the local filesystem.
/// Load [RsaPublicKey][`crate::public_key::RsaPublicKey`] from a PEM-encoded file on the local filesystem.
#[cfg(all(feature = "pem", feature = "std"))]
#[cfg_attr(docsrs, doc(cfg(feature = "pem")))]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
Expand All @@ -96,7 +96,7 @@ pub trait DecodeRsaPublicKey: Sized {
}
}

/// Serialize a [`RsaPrivateKey`] to a PKCS#1 encoded document.
/// Serialize a [RsaPrivateKey][`crate::private_key::RsaPrivateKey`] to a PKCS#1 encoded document.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
pub trait EncodeRsaPrivateKey {
Expand Down Expand Up @@ -125,7 +125,7 @@ pub trait EncodeRsaPrivateKey {
}
}

/// Serialize a [`RsaPublicKey`] to a PKCS#1-encoded document.
/// Serialize a [RsaPublicKey][`crate::public_key::RsaPublicKey`] to a PKCS#1-encoded document.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
pub trait EncodeRsaPublicKey {
Expand Down