CStr: add some doc links

This commit is contained in:
Ralf Jung 2022-10-28 10:24:14 +02:00
parent cdd7afeaad
commit a6c3f6ce1d

View File

@ -13,9 +13,9 @@ use crate::str;
/// array of bytes. It can be constructed safely from a <code>&[[u8]]</code> /// array of bytes. It can be constructed safely from a <code>&[[u8]]</code>
/// slice, or unsafely from a raw `*const c_char`. It can then be /// slice, or unsafely from a raw `*const c_char`. It can then be
/// converted to a Rust <code>&[str]</code> by performing UTF-8 validation, or /// converted to a Rust <code>&[str]</code> by performing UTF-8 validation, or
/// into an owned `CString`. /// into an owned [`CString`].
/// ///
/// `&CStr` is to `CString` as <code>&[str]</code> is to `String`: the former /// `&CStr` is to [`CString`] as <code>&[str]</code> is to [`String`]: the former
/// in each pair are borrowed references; the latter are owned /// in each pair are borrowed references; the latter are owned
/// strings. /// strings.
/// ///
@ -24,6 +24,9 @@ use crate::str;
/// functions may leverage the unsafe [`CStr::from_ptr`] constructor to provide /// functions may leverage the unsafe [`CStr::from_ptr`] constructor to provide
/// a safe interface to other consumers. /// a safe interface to other consumers.
/// ///
/// [`CString`]: ../../std/ffi/struct.CString.html
/// [`String`]: ../../std/string/struct.String.html
///
/// # Examples /// # Examples
/// ///
/// Inspecting a foreign C string: /// Inspecting a foreign C string: