]> Sergey Matveev's repositories - btrtrc.git/blobdiff - storage/interface.go
Fix UseSources panicking when sqlite storage is closed
[btrtrc.git] / storage / interface.go
index 132d4c856dd559cf9e4f46c0ffb8b969b1c0dd7a..9e8de06c8f55313370e938d386f234f45b22e3d3 100644 (file)
@@ -6,21 +6,36 @@ import (
        "github.com/anacrolix/torrent/metainfo"
 )
 
+type ClientImplCloser interface {
+       ClientImpl
+       Close() error
+}
+
 // Represents data storage for an unspecified torrent.
 type ClientImpl interface {
        OpenTorrent(info *metainfo.Info, infoHash metainfo.Hash) (TorrentImpl, error)
 }
 
+type TorrentCapacity *func() (cap int64, capped bool)
+
 // Data storage bound to a torrent.
-type TorrentImpl interface {
-       Piece(metainfo.Piece) PieceImpl
-       Close() error
+type TorrentImpl struct {
+       Piece func(p metainfo.Piece) PieceImpl
+       Close func() error
+       Flush func() error
+       // Storages that share the same space, will provide equal pointers. The function is called once
+       // to determine the storage for torrents sharing the same function pointer, and mutated in
+       // place.
+       Capacity TorrentCapacity
 }
 
-// Interacts with torrent piece data.
+// Interacts with torrent piece data. Optional interfaces to implement include:
+//
+//     io.WriterTo, such as when a piece supports a more efficient way to write out incomplete chunks.
+//     SelfHashing, such as when a piece supports a more efficient way to hash its contents.
 type PieceImpl interface {
        // These interfaces are not as strict as normally required. They can
-       // assume that the parameters are appropriate for the dimentions of the
+       // assume that the parameters are appropriate for the dimensions of the
        // piece.
        io.ReaderAt
        io.WriterAt
@@ -30,5 +45,16 @@ type PieceImpl interface {
        MarkComplete() error
        MarkNotComplete() error
        // Returns true if the piece is complete.
-       GetIsComplete() bool
+       Completion() Completion
+}
+
+type Completion struct {
+       Complete bool
+       Ok       bool
+       Err      error
+}
+
+// Allows a storage backend to override hashing (i.e. if it can do it more efficiently than the torrent client can)
+type SelfHashing interface {
+       SelfHash() (metainfo.Hash, error)
 }