Skip to content
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

Jump to bottom

Delevel headers in crate-level documentation #1000

Merged
merged 1 commit into from
Mar 2, 2024
Merged

Delevel headers in crate-level documentation #1000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ so you don't have to.

## Overview

####### Conversion Traits
###### Conversion Traits

Zerocopy provides four derivable traits for zero-cost conversions:
- `TryFromBytes` indicates that a type may safely be converted from
Expand All @@ -37,7 +37,7 @@ Zerocopy provides four derivable traits for zero-cost conversions:
- `IntoBytes` indicates that a type may safely be converted *to* a byte
sequence

####### Marker Traits
###### Marker Traits

Zerocopy provides three derivable marker traits that do not provide any
functionality themselves, but are required to call certain methods provided
Expand All @@ -49,7 +49,7 @@ by the conversion traits:

You should generally derive these marker traits whenever possible.

####### Conversion Macros
###### Conversion Macros

Zerocopy provides three macros for safe, zero-cost casting between types:

Expand All @@ -64,7 +64,7 @@ These macros perform *compile-time* alignment and size checks, but cannot be
used in generic contexts. For generic conversions, use the methods defined
by the [conversion traits](#conversion-traits).

####### Byteorder-Aware Numerics
###### Byteorder-Aware Numerics

Zerocopy provides byte-order aware integer types that support these
conversions; see the `byteorder` module. These types are especially useful
Expand Down
8 changes: 4 additions & 4 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
//!
//! # Overview
//!
//! ###### Conversion Traits
//! ##### Conversion Traits
//!
//! Zerocopy provides four derivable traits for zero-cost conversions:
//! - [`TryFromBytes`] indicates that a type may safely be converted from
Expand All @@ -37,7 +37,7 @@
//! - [`IntoBytes`] indicates that a type may safely be converted *to* a byte
//! sequence
//!
//! ###### Marker Traits
//! ##### Marker Traits
//!
//! Zerocopy provides three derivable marker traits that do not provide any
//! functionality themselves, but are required to call certain methods provided
Expand All @@ -49,7 +49,7 @@
//!
//! You should generally derive these marker traits whenever possible.
//!
//! ###### Conversion Macros
//! ##### Conversion Macros
//!
//! Zerocopy provides three macros for safe, zero-cost casting between types:
//!
Expand All @@ -64,7 +64,7 @@
//! used in generic contexts. For generic conversions, use the methods defined
//! by the [conversion traits](#conversion-traits).
//!
//! ###### Byteorder-Aware Numerics
//! ##### Byteorder-Aware Numerics
//!
//! Zerocopy provides byte-order aware integer types that support these
//! conversions; see the [`byteorder`] module. These types are especially useful
Expand Down
Loading