Refs #150 -- document CStr itself (#205)

alex · web-flow · commit 2877b7117c92 · 2020-07-12T17:55:35.000-04:00
diff --git a/src/types.rs b/src/types.rs
@@ -14,6 +14,8 @@ impl Mode {
     }
 }
 
+/// A string that is guaranteed to have exactly one NUL byte, which is at the
+/// end. Used for interoperability with kernel APIs that take C strings.
 #[repr(transparent)]
 pub struct CStr(str);
 

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@ impl Mode {`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`
	`17`	`+/// A string that is guaranteed to have exactly one NUL byte, which is at the`
	`18`	`+/// end. Used for interoperability with kernel APIs that take C strings.`
`17`	`19`	`#[repr(transparent)]`
`18`	`20`	`pub struct CStr(str);`
`19`	`21`