about summary refs log tree commit homepage
path: root/lib/mogilefs/util.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/mogilefs/util.rb')
-rw-r--r--lib/mogilefs/util.rb7
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/mogilefs/util.rb b/lib/mogilefs/util.rb
index cdd67d7..6277497 100644
--- a/lib/mogilefs/util.rb
+++ b/lib/mogilefs/util.rb
@@ -1,6 +1,13 @@
 # -*- encoding: binary -*-
 
 module MogileFS::Util
+
+  # MogileFS::Util::StoreContent allows you to roll your own method
+  # of streaming data on an upload (instead of using a string or file)
+  #
+  # Current versions of this library support streaming a IO or IO-like
+  # object to using MogileFS::MogileFS#store_file, so using StoreContent
+  # may no longer be necessary.
   class StoreContent < Proc
     def initialize(total_size, &writer_proc)
       @total_size = total_size