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.

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

docs: fix cargo doc warnings #1919

Merged
merged 1 commit into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 h3i/src/client/connection_summary.rs
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ impl StreamMap {
/// suites which depend heavily on h3i.
///
/// The specific CONNECTION_CLOSE frame can be customized by passing a
/// [`ConnectionError`] to [`Self::new_with_close`]. h3i will send an
/// [`ConnectionError`] to [`Self::new_with_connection_close`]. h3i will send an
/// application CONNECTION_CLOSE frame with error code 0x100 if this struct is
/// constructed with the [`Self::new`] constructor.
#[derive(Clone, Serialize, Debug)]
Expand Down
2 changes: 1 addition & 1 deletion h3i/src/frame.rs
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,7 @@ impl CloseTriggerFrame {
/// For Headers variants, this [`CloseTriggerFrame`] is equivalent to the
/// incoming [`H3iFrame`] if the [`H3iFrame`] contains all [`Header`]s
/// in _this_ frame. In other words, `this` can be considered equivalent
/// to `other` if `other` contains a superset of `this`'s [`Headers`].
/// to `other` if `other` contains a superset of `this`'s [`Header`]s.
///
/// This allows users for fuzzy-matching on header frames without needing to
/// supply every individual header on the frame.
Expand Down
8 changes: 4 additions & 4 deletions h3i/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -163,22 +163,22 @@ use smallvec::SmallVec;

/// The ID for an HTTP/3 control stream type.
///
/// See https://datatracker.ietf.org/doc/html/rfc9114#name-control-streams.
/// See <https://datatracker.ietf.org/doc/html/rfc9114#name-control-streams>.
pub const HTTP3_CONTROL_STREAM_TYPE_ID: u64 = 0x0;

/// The ID for an HTTP/3 push stream type.
///
/// See https://datatracker.ietf.org/doc/html/rfc9114#name-push-streams.
/// See <https://datatracker.ietf.org/doc/html/rfc9114#name-push-streams>.
pub const HTTP3_PUSH_STREAM_TYPE_ID: u64 = 0x1;

/// The ID for a QPACK encoder stream type.
///
/// See https://datatracker.ietf.org/doc/html/rfc9204#section-4.2-2.1.
/// See <https://datatracker.ietf.org/doc/html/rfc9204#section-4.2-2.1>.
pub const QPACK_ENCODER_STREAM_TYPE_ID: u64 = 0x2;

/// The ID for a QPACK decoder stream type.
///
/// See https://datatracker.ietf.org/doc/html/rfc9204#section-4.2-2.2.
/// See <https://datatracker.ietf.org/doc/html/rfc9204#section-4.2-2.2>.
pub const QPACK_DECODER_STREAM_TYPE_ID: u64 = 0x3;

#[derive(Default)]
Expand Down
1 change: 1 addition & 0 deletions quiche/src/h3/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1180,6 +1180,7 @@ impl Connection {
/// struct.Connection.html#method.send_additional_headers
/// [`send_response_with_priority()`]:
/// struct.Connection.html#method.send_response_with_priority
/// [`FrameUnexpected`]: enum.Error.html#variant.FrameUnexpected
/// [`StreamBlocked`]: enum.Error.html#variant.StreamBlocked
pub fn send_response<T: NameValue>(
&mut self, conn: &mut super::Connection, stream_id: u64, headers: &[T],
Expand Down
Loading