Skip to content

Commit

Permalink
doc link fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
zslayton committed Oct 20, 2023
1 parent 528cac1 commit 1b5de55
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 8 deletions.
2 changes: 1 addition & 1 deletion src/binary/non_blocking/raw_binary_reader.rs
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ impl Container {
/// A raw binary reader that pulls input bytes from a fixed buffer.
///
/// If any read operation fails due to the buffer containing incomplete data, that method will
/// return [`IonError::Incomplete`](crate::IonError::Incomplete).
/// return [`IonError::Incomplete`].
///
/// If the buffer (generic type `A`) is a [`Vec<u8>`], then data can be appended to it between read
/// operations. This can be useful when reading from a data source that is growing over time, such
Expand Down
2 changes: 1 addition & 1 deletion src/element/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

//! Provides a dynamically typed, materialized representation of an Ion value.
//!
//! An [Element](Element) represents an `(annotations, value)` pair, where a `value` is
//! An [Element] represents an `(annotations, value)` pair, where a `value` is
//! an Ion `integer`, `float`, `list`, `struct`, etc.
//!
//! For reference here are a couple other _value_ style APIs for JSON:
Expand Down
2 changes: 1 addition & 1 deletion src/ion_reader.rs
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ pub trait IonReader {
/// error is encountered while reading, returns [crate::IonError].
fn read_i64(&mut self) -> IonResult<i64>;

/// Attempts to read the current item as an Ion integer and return it as an [`Int`](crate::types::Int). If the
/// Attempts to read the current item as an Ion integer and return it as an [`Int`]. If the
/// current item is not an integer or an IO error is encountered while reading, returns
/// [crate::IonError].
fn read_int(&mut self) -> IonResult<Int>;
Expand Down
2 changes: 1 addition & 1 deletion src/lazy/expanded/template.rs
Original file line number Diff line number Diff line change
Expand Up @@ -833,7 +833,7 @@ impl TemplateValue {
pub type ExprRange = SmallRange;
pub type AnnotationsRange = SmallRange;

/// A range that takes 8 bytes instead of Range<usize>'s 16. This is useful for cases like
/// A range that takes 8 bytes instead of `Range<usize>`'s 16. This is useful for cases like
/// annotations where a capacity of 4 billion+ is more than enough. It also implements `Copy`,
/// making it possible for enclosing types to also implement `Copy`.
#[derive(Clone, Copy, Debug, PartialEq)]
Expand Down
9 changes: 5 additions & 4 deletions src/lazy/system_reader.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,11 @@ const SYMBOLS: RawSymbolTokenRef = RawSymbolTokenRef::SymbolId(7);
/// which may contain either a scalar value or a lazy container that may itself be traversed.
///
/// The values that the reader yields ([`LazyValue`],
/// [`crate::lazy::sequence::LazyBinarySequence`], and [`LazyStruct`]) are immutable
/// references to the data stream, and remain valid until [`LazySystemReader::next_item`] is
/// called again to advance the reader to the next top level value. This means that these references
/// can be stored, read, and re-read as long as the reader remains on the same top-level value.
/// [`LazyBinarySequence`](crate::lazy::sequence::LazyBinarySequence) and
/// [`LazyStruct`](crate::lazy::struct::LazyStruct)), are immutable references to the data stream,
/// and remain valid until [`LazySystemReader::next_item`] is called again to advance the reader to
/// the next top level value. This means that these references can be stored, read, and re-read as
/// long as the reader remains on the same top-level value.
/// ```
///# use ion_rs::IonResult;
///# fn main() -> IonResult<()> {
Expand Down

0 comments on commit 1b5de55

Please sign in to comment.