Skip to content

Commit 67bf22d

Browse files
committed
Document diesel::row::Row
I had excluded this trait, as I intended for it to be mostly internal. I still think this should be the case, but until I can provide a proper blanket impl for `FromSqlRow`, this type will need to be public. Fixes diesel-rs#535.
1 parent 7b9355e commit 67bf22d

2 files changed

Lines changed: 4 additions & 1 deletion

File tree

diesel/src/lib.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ pub mod migrations;
3030
mod query_dsl;
3131
pub mod query_source;
3232
pub mod result;
33-
#[doc(hidden)]
3433
pub mod row;
3534

3635
pub mod helper_types {

diesel/src/row.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
use backend::Backend;
22

3+
/// The row trait which is used for [`FromSqlRow`][]. Apps should not need to
4+
/// concern themselves with this trait.
5+
///
6+
/// [`FromSqlRow`]: ../types/trait.FromSqlRow.html
37
pub trait Row<DB: Backend> {
48
fn take(&mut self) -> Option<&DB::RawValue>;
59
fn next_is_null(&self, count: usize) -> bool;

0 commit comments

Comments
 (0)