doc: add read/write example to readme

Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
This commit is contained in:
Noah Watkins 2014-12-03 21:05:08 -08:00
parent 04fbadc60d
commit 507dc20bc7
1 changed files with 22 additions and 0 deletions

View File

@ -44,6 +44,28 @@ err := conn.ParseCmdLineArgs(args)
For other configuration options see the full documentation.
### Object I/O
Object in RADOS can be written to and read from with through an interface very
similar to a standard file I/O interface:
```go
// open a pool handle
pool, err := conn.OpenPool("mypool")
// write some data
bytes_in := []byte("input data")
err = pool.Write("obj", bytes_in, 0)
// read the data back out
bytes_out := make([]byte, len(bytes_in))
n_out, err := pool.Read("obj", bytes_out, 0)
if bytes_in != bytes_out {
fmt.Println("Output is not input!")
}
```
### Pool maintenance
The list of pools in a cluster can be retreived using the `ListPools` method