Chunk — Documentation by YARD 0.9.37 (original) (raw)

Class: Mongo::Grid::File::Chunk

Inherits:

Object

• Object
• Mongo::Grid::File::Chunk show all

Defined in:

lib/mongo/grid/file/chunk.rb

Overview

Encapsulates behavior around GridFS chunks of file data.

Constant Summarycollapse

COLLECTION =

Name of the chunks collection.

'chunks'.freeze

DEFAULT_SIZE =

Default size for chunks of data.

(255 * 1024).freeze

Instance Attribute Summary collapse

• #document ⇒ BSON::Document readonly
  Document The document to store for the chunk.

Class Method Summarycollapse

• .assemble(chunks) ⇒ String private
  Takes an array of chunks and assembles them back into the full piece of raw data.
• .split(io, file_info, offset = 0) ⇒ Array private
  Split the provided data into multiple chunks.

Instance Method Summarycollapse

• #==(other) ⇒ true, false
  Check chunk equality.
• #bson_type ⇒ Integer
  Get the BSON type for a chunk document.
• #data ⇒ BSON::Binary
  Get the chunk data.
• #files_id ⇒ BSON::ObjectId
  Get the files id.
• #id ⇒ BSON::ObjectId
  Get the chunk id.
• #initialize(document) ⇒ Chunk constructor
  Create the new chunk.
• #n ⇒ Integer
  Get the chunk position.
• #to_bson(buffer = BSON::ByteBuffer.new, validating_keys = nil) ⇒ String
  Conver the chunk to BSON for storage.

Constructor Details

#initialize(document) ⇒ Chunk

Instance Attribute Details

#document ⇒ BSON::Document

Returns document The document to store for the chunk.

Class Method Details

.assemble(chunks) ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Takes an array of chunks and assembles them back into the full piece of raw data.

| 159 160 161 | # File 'lib/mongo/grid/file/chunk.rb', line 159 def assemble(chunks) chunks.reduce(+''){ |data, chunk| data << chunk.data.data } end | | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------- |

.split(io, file_info, offset = 0) ⇒ Array<Chunk>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Split the provided data into multiple chunks.

| 176 177 178 179 180 181 182 183 184 185 186 187 | # File 'lib/mongo/grid/file/chunk.rb', line 176 def split(io, file_info, offset = 0) io = StringIO.new(io) if io.is_a?(String) parts = Enumerator.new { |y| y << io.read(file_info.chunk_size) until io.eof? } parts.map.with_index do | bytes, n| file_info.update_md5(bytes) Chunk.new( data: BSON::Binary.new(bytes), files_id: file_info.id, n: n + offset ) end end | | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

Instance Method Details

#==(other) ⇒ true, false

#bson_type ⇒ Integer

Get the BSON type for a chunk document.

#data ⇒ BSON::Binary

#files_id ⇒ BSON::ObjectId

#id ⇒ BSON::ObjectId

#n ⇒ Integer

#to_bson(buffer = BSON::ByteBuffer.new, validating_keys = nil) ⇒ String

Conver the chunk to BSON for storage.