tsarevvv/rust-ipfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: revisit file.rs docs

Browse Source
This commit is contained in:
Joonas Koivunen 2020-08-14 15:51:35 +03:00
parent b671a767f1
commit 3176976ba2
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
unixfs/src/file.rs
View File

@ -1,7 +1,7 @@
///! UnixFS file support.
///!
///! Most usable for walking UnixFS file trees provided by the `visit::IdleFileVisit` and
///! `visit::FileVisit` types.
///! Module provides low-level File tree visitor support and file importing support. Note: The
///! [`ipfs_unixfs::walk::Walker`] should be used for accessing file content typically.
use crate::pb::ParsingFailed;
use crate::{InvalidCidInLink, Metadata, UnexpectedNodeType};
use std::borrow::Cow;
@ -10,10 +10,10 @@ use std::fmt;
/// Low level UnixFS file descriptor reader support.
mod reader;
/// Higher level API for visiting the file tree.
/// Mid level API for visiting the file tree.
pub mod visit;
/// Initial version of file adder capable of constructing UnixFs v1 trees
/// File adder capable of constructing UnixFs v1 trees
pub mod adder;
/// Describes the errors which can happen during a visit or lower level block-by-block walking of