Class MongoGridFSStream

Namespace

MongoDB.Driver.GridFS

Assembly

MongoDB.Driver.Legacy.dll

Represents a stream interface to a GridFS file (patterned after .NET's Stream class).

public class MongoGridFSStream : Stream, IDisposable

Inheritance

object

MarshalByRefObject

Stream

MongoGridFSStream

Implements

IDisposable

Inherited Members

Stream.Null

Stream.BeginRead(byte[], int, int, AsyncCallback, object)

Stream.BeginWrite(byte[], int, int, AsyncCallback, object)

Stream.Close()

Stream.CopyTo(Stream)

Stream.CopyTo(Stream, int)

Stream.CopyToAsync(Stream)

Stream.CopyToAsync(Stream, int)

Stream.CopyToAsync(Stream, int, CancellationToken)

Stream.CreateWaitHandle()

Stream.Dispose()

Stream.EndRead(IAsyncResult)

Stream.EndWrite(IAsyncResult)

Stream.FlushAsync()

Stream.FlushAsync(CancellationToken)

Stream.ObjectInvariant()

Stream.ReadAsync(byte[], int, int)

Stream.ReadAsync(byte[], int, int, CancellationToken)

Stream.Synchronized(Stream)

Stream.WriteAsync(byte[], int, int)

Stream.WriteAsync(byte[], int, int, CancellationToken)

Stream.CanTimeout

Stream.ReadTimeout

Stream.WriteTimeout

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.MemberwiseClone(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

LinqToMongo.In<TSource>(TSource, IEnumerable<TSource>)

Constructors

MongoGridFSStream(MongoGridFSFileInfo, FileMode)

Initializes a new instance of the MongoGridFSStream class.

public MongoGridFSStream(MongoGridFSFileInfo fileInfo, FileMode mode)

Parameters

fileInfo MongoGridFSFileInfo

The GridFS file info.

mode FileMode

The mode.

MongoGridFSStream(MongoGridFSFileInfo, FileMode, FileAccess)

Initializes a new instance of the MongoGridFSStream class.

public MongoGridFSStream(MongoGridFSFileInfo fileInfo, FileMode mode, FileAccess access)

Parameters

fileInfo MongoGridFSFileInfo

The GridFS file info.

mode FileMode

The mode.

access FileAccess

The acess.

Properties

CanRead

Gets whether the GridFS stream supports reading.

public override bool CanRead { get; }

Property Value

bool

CanSeek

Gets whether the GridFS stream supports seeking.

public override bool CanSeek { get; }

Property Value

bool

CanWrite

Gets whether the GridFS stream supports writing.

public override bool CanWrite { get; }

Property Value

bool

Length

Gets the current length (use SetLength to change the length).

public override long Length { get; }

Property Value

long

Position

Gets or sets the current position.

public override long Position { get; set; }

Property Value

long

UpdateMD5

Gets or sets a value indicating whether to compute and update the MD5 hash for the file when the stream is closed.

[Obsolete("Use UpdateMD5 on MongoGridFSSettings instead.")]
public bool UpdateMD5 { get; set; }

Property Value

bool

Methods

Dispose(bool)

Disposes of any resources used by the stream.

protected override void Dispose(bool disposing)

Parameters

disposing bool

True if called from Dispose.

Flush()

Flushes any unsaved data in the buffers to the GridFS file.

public override void Flush()

Read(byte[], int, int)

Reads bytes from the GridFS stream.

public override int Read(byte[] buffer, int offset, int count)

Parameters

buffer byte[]

The destination buffer.

offset int

The offset in the destination buffer at which to place the read bytes.

count int

The number of bytes to read.

Returns

int

The number of bytes read.

ReadByte()

Reads one byte from the GridFS stream.

public override int ReadByte()

Returns

int

The byte (-1 if at the end of the GridFS stream).

Seek(long, SeekOrigin)

Seeks to a new position.

public override long Seek(long offset, SeekOrigin origin)

Parameters

offset long

The seek offset.

origin SeekOrigin

The seek origin.

Returns

long

The new position.

SetLength(long)

Sets the length of the GridFS file.

public override void SetLength(long value)

Parameters

value long

The length.

Write(byte[], int, int)

Writes bytes to the GridFS stream.

public override void Write(byte[] buffer, int offset, int count)

Parameters

buffer byte[]

The source buffer.

offset int

The offset in the source buffer to the bytes.

count int

The number of bytes to write.

WriteByte(byte)

Writes one byte to the GridFS stream.

public override void WriteByte(byte value)

Parameters

value byte

The byte.