Skip to content

Commit d34afe9

Browse files
committed
doc: improve SpooledData documentation
1 parent 6deb42e commit d34afe9

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/spooled.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ use std::fs::File;
44
use std::io::{self, Cursor, Read, Seek, SeekFrom, Write};
55
use std::path::{Path, PathBuf};
66

7-
/// A wrapper for the two states of a `SpooledTempFile`.
7+
/// A wrapper for the two states of a [`SpooledTempFile`]. Either:
8+
///
9+
/// 1. An in-memory [`Cursor`] representing the state of the file.
10+
/// 2. A temporary [`File`].
811
#[derive(Debug)]
912
pub enum SpooledData {
1013
InMemory(Cursor<Vec<u8>>),

0 commit comments

Comments
 (0)