66

During the serialization we can use either memory stream or file stream.

What is the basic difference between these two? What does memory stream mean?

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Runtime.Serialization.Formatters.Binary;

namespace Serilization
{
    class Program
    {
        static void Main(string[] args)
        {
            MemoryStream aStream = new MemoryStream();
            BinaryFormatter aBinaryFormat = new BinaryFormatter();
            aBinaryFormat.Serialize(aStream, person);
            aStream.Close();
        }
    }
}
Brandon
  • 65,640
  • 30
  • 189
  • 218
Raghav55
  • 2,725
  • 6
  • 24
  • 36

8 Answers8

103

Stream is a representation of bytes. Both these classes derive from the Stream class which is abstract by definition.

As the name suggests, a FileStream reads and writes to a file whereas a MemoryStream reads and writes to the memory. So it relates to where the stream is stored.

Now it depends how you plan to use both of these. For eg: Let us assume you want to read binary data from the database, you would go in for a MemoryStream. However if you want to read a file on your system, you would go in for a FileStream.

One quick advantage of a MemoryStream is that there is not need to create temporary buffers and files in an application.

Enigma State
  • 16,494
  • 25
  • 86
  • 179
  • 11
    since the object is already in the memory, why do we to allocate a memory stream for the serilization? – Raghav55 Nov 16 '11 at 18:51
  • Because the memory stream manipulates the object as a sequence of bytes, not as its logical program "meaning". – Tudor Nov 16 '11 at 18:52
  • @tudor: since i am novice to .net, can u explain in breif about this? – Raghav55 Nov 16 '11 at 18:56
  • 21
    @Raghav55: An object can be reduced to a sequence of bytes, correct? Inside your program logic, that object has a meaning, like a Person holding information like name, address, etc. This is how the object appears in your program. When you serialize it to a memory stream, it gets reduced to a stream of bytes with no meaning. It is only stored but it has no actual value to your program logic. – Tudor Nov 16 '11 at 20:03
  • 1
    I'm reading a huge amount of date from a DB and want to send it back to the user as a csv file but i'm running out of memory using the memorystream... I believe i'm going to have to convert it to a filestream for more space. – RayLoveless Jul 28 '16 at 16:32
  • I'm a little curious about the underlying process when reading a file from filesystem,isn't it first to load from disk to memory?I think `FileStream` and `MemoryStream` are both reside in memory. – zionpi Nov 28 '18 at 02:13
51

The other answers here are great, but I thought one that takes a really high level look at what purpose steams serve might be useful. There's a bit of simplification going on in the explanation below, but hopefully this gets the idea across:

What is a stream?

A stream is effectively the flow of data between two places, it's the pipe rather than the contents of that pipe.

A bad analogy to start

Imagine a water desalination plant (something that takes seawater, removes the salt and outputs clean drinking water to the water network):

The desalination plant can't remove the salt from all of the sea at one time (and nor would we want it to… where would the saltwater fish live?), so instead we have:

  • A SeaStream that sucks a set amount of water at a time into the plant.
  • That SeaStream is connected to the DesalinationStream to remove the salt
  • And the output of the DesalinationStream is connected to the DrinkingWaterNetworkStream to output the now saltless water to the drinking water supply.

OK, so what's that got to do with computers?

Moving big files all at once can be problematic

Frequently in computing we want to move data between two locations, e.g. from an external hard drive to a binary field in a database (to use the example given in another answer). We can do that by copying all of the data from the file from location A into the computer's memory and from there to to Location B, but if the file is large or the source or destination are potentially unreliable then moving the whole file at once may be either unfeasible or unwise.

For example, say we want to move a large file on a USB stick to a field in a database. We could use a 'System.IO.File' object to retrieve that whole file into the computer's memory and then use a database connection to pass that file onto the database.

But, that's potentially problematic, what if the file is larger than the computer's available RAM? Now the file will potentially be cached to the hard drive, which is slow, and it might even slow the computer down too.

Likewise, what if the data source is unreliable, e.g. copying a file from a network drive with a slow and flaky WiFi connection? Trying to copy a large file in one go can be infuriating because you get half the file and then the connection drops out and you have to start all over again, only for it to potentially fail again.

It can be better to split the file and move it a piece at a time

So, rather than getting whole file at once, it would be better to retrieve the file a piece at a time and pass each piece on to the destination one at a time. This is what a Stream does and that's where the two different types of stream you mentioned come in:

  • We can use a FileStream to retrieve data from a file a piece at a time
  • and the database API may make available a MemoryStream endpoint we can write to a piece at a time.
  • We connect those two 'pipes' together to flow the file pieces from file to database.

Even if the file wasn't too big to be held in RAM, without streams we were still doing a number or read/write operations that we didn't need to. The stages we we're carrying out were:

  1. Retrieving the data from the disk (slow)
  2. Writing to a File object in the computer's memory (a bit faster)
  3. Reading from that File object in the computer's memory (faster again)
  4. Writing to the database (probably slow as there's probably a spinning disk hard-drive at the end of that pipe)

Streams allow us to conceptually do away with the middle two stages, instead of dragging the whole file into computer memory at once, we take the output of the operation to retrieve the data and pipe that straight to the operation to pass the data onto the database.

Other benefits of streams

Separating the retrieval of the data from the writing of the data like this also allows us to perform actions between retrieving the data and passing it on. For example, we could add an encryption stage, or we could write the incoming data to more than one type of output stream (e.g. to a FileStream and a NetworkStream).

Streams also allow us to write code where we can resume the operation should the transfer fail part way through. By keeping track of the number of pieces we've moved, if the transfer fails (e.g. if the network connection drops out) we can restart the Stream from the point at which we received the last piece (this is the offset in the BeginRead method).

tomRedox
  • 18,963
  • 13
  • 90
  • 126
  • Thanks you! "the database API may make available a `MemoryStream` endpoint" has been the clarification I seeked to understand writing to the console using a `MemoryStream`. – Stefan Mar 31 '21 at 08:25
9

In simplest form, a MemoryStream writes data to memory, while a FileStream writes data to a file.

Typically, I use a MemoryStream if I need a stream, but I don't want anything to hit the disk, and I use a FileStream when writing a file to disk.

AllenG
  • 7,946
  • 26
  • 38
8

While a file stream reads from a file, a memory stream can be used to read data mapped in the computer's internal memory (RAM). You are basically reading/writing streams of bytes from memory.

Tudor
  • 58,972
  • 12
  • 89
  • 138
  • which is one better when serilazing the large data? If the serilize data is big and avaiable memory is small. Wht will happen in this case when we use memory stream? – Raghav55 Nov 16 '11 at 18:46
  • 1
    If your data exceeds the available memory, it will start to page to the disk eventually. This is bad because the entire system performance will degrade. In this case it's better to just stream to a file. – Tudor Nov 16 '11 at 18:50
6

Having a bitter experience on the subject, here's what I've found out. if performance is required, you should copy the contents of a filestream to a memorystream. I had to process the contents of 144 files, 528kbytes each and present the outcome to the user. It took 250 seconds aprox. (!!!!). When I just copied the contents of each filestream to a memorystream, (CopyTo method) without changing anything at all, the time dropped to approximately 32 seconds. Note that each time you copy one stream to another, the stream is appended at the end of the destination stream, so you may need to 'rewind' it prior to copying to it. Hope it helps.

ManosG
  • 61
  • 1
  • 1
  • 9
    Bitter experience?!? Well of course manipulating files in RAM is going to be faster than manipulating files on disk. What did you expect? ;-) – tomfanning Aug 09 '12 at 11:31
2

In regards to stream itself, in general, it means that when you put a content into the stream (memory), it will not put all the content of whatever data source (file, db...) you are working with, to the memory. As opposed to for example Arrays or Buffers, where you feed everything to the memory. In stream, you get a chunk of eg. file to the memory. When you reach the end of chunk, stream gets the next chunk from file to the memory. It all happens in low-level background while you are just iterating the stream. That's why it's called stream.

InGeek
  • 1,932
  • 2
  • 20
  • 34
2

A memory stream handles data via an in memory buffer. A filestream deals with files on disk.

Christopher Currens
  • 27,427
  • 5
  • 51
  • 74
  • Hi Christopher, wanna ask a question here. So does it mean that if I use a memory stream, the pattern is "data not produced from files (e.g. `fprintf(memory_buf, "hello")`) < - - transfer - - > memory buffer process data", while for file-based stream, the pattern is "data lies/produces/comes from disk < - - transfer - - > memory buffer process data" ? – Rick Mar 07 '19 at 03:08
0

Serializing objects in memory is hardly any useful, in my opinion. You need to serialize an object when you want to save it on disk. Typically, serialization is done from the object(which is in memory) to the disk while deserialization is done from the saved serialized object(on the disk) to the object(in memory).

So, most of the times, you want to serialize to disk, thus you use a Filestream for serialization.

ThunderGr
  • 2,071
  • 23
  • 20