Fortsätt till huvudinnehåll

C# Deconstruct and Discards

 Deconstruct and Discards

In the last post I mentioned the Deconstruct method and how it should not be mixed up with a Destructor. In this post I will show some examples and how you can use Deconstruct and especially in combination with something called Discards.

The Deconstruct method can be defined within a class to provide a way to retrieve a Tuple of the data that makes up the type and Discards can be used by the caller to effectively ignore the members of the Tuple that aren't of interest.

Sounds complicated? Hopefully the examples below will clear things out.

Implementing the Deconstruct method

Let's start with a simple container class holding attributes of a file in the filesystem.

public class FileInfo
{
  public string Name { get; }
  public int SizeInBytes { get; }
  public bool ReadOnly { get; }

  public FileInfo(string name, int sizeInBytes, bool readOnly)
  {
    Name = name;
    SizeInBytes = sizeInBytes;
    ReadOnly = readOnly;
  }

   public void Deconstruct(out string name, out int sizeInBytes, out bool readOnly)
  {
    name = Name;
    sizeInBytes = SizeInBytes;
    readOnly = ReadOnly;
  }
}

In this case the Deconstructor works as an alternative to using the public attributes. To use the Deconstruct method to extract the attributes declare a Tuple and assign on object instance of the FileInfo class to it.

var fileInfo = new FileInfo("MyFile.txt", 1024, true);
...
var (fileName, fileSize, readOnly) = fileInfo;
Console.WriteLine($"The file {fileName} is {fileSize} bytes and its read only attribute is set to {readOnly}");

Ok, this looks cool and all, but why should you use the Deconstructor instead of just the public attributes? That is actually a really good question. From what I can read between the lines in this blogpost from Microsoft the ability to add Deconstructors in this way was added as a way to create symmetry by adding Constructors and Deconstructors pairwise. For every Constructor you add to your class, you can now add a corresponding Deconstructor which returns the Constructor parameters. Whether you want to use Deconstructors or not is up to you and your development team.

Discard tuples members with Discards

It is possible to discard any members of the returned Tuple by using a single underscore, '_', instead of a parameter name. For example, if the only parameter of interest in the FileInfo object is the fileName the other two members of the Tuple can be discarded like this:

...
var (fileName, _, _) = fileInfo;
...

More resources

Deconstructing tuples and other types
What's new in C# 7
Discards

Kommentarer

Skicka en kommentar

Populära inlägg i den här bloggen

Does TDD really improve software quality?

I have asked myself this question several times, and searched for answers, without coming up with any clear answer. Therefore I have decided to go hard core TDD for a longer period of time (at least 6 months) to really evaluate the effects. There are several things that I find confusing when it comes to TDD. One example is what actually defines a unit test. What is a "unit" anyway? After reading a bit about it I found a text claiming that the "unit" is "a unit of work", i.e. something quite small. Like converting a string to UPPERCASE or splitting a string into an ['a','r', 'r', 'a', 'y'] of chars. This work is usually performed by a single call to a single method in a single, isolated, class. So, what does it mean that a class is isolated? Does it mean that it doesn't have any dependencies to other classes? NO! In the context of TDD it means that any dependencies are supplied by the test environment, for exa...
3 kommentarer
Läs mer

Codility tasks - Part I

I was recently faced with two codility tasks when applying for a job as an Embedded Software Engineer. For those of you who arn't familiar with Codility you can check out their website here:  www.codility.com Task one - Dominator The first task was called Dominator. The goal was to, given a std::vector of integers, find an integer that occurs in more than half of the positions in the vector. If no dominator was found -1 should be returned. My approach was to loop through the vector from the first to the last element, using a std::map to count the number of occurences of each integer. If the count ever reached above half the size of the vector I stopped and returned that integer and if I reached the end without finding a dominator I returned -1. So was that a good approach? Well, the reviewer at the company rated the solution as 'pretty ok'. His preferred solution was store the first integer in the array and set a counter to 1. Then loop through the remaining i...
7 kommentarer
Läs mer

Codility tasks - Part II

Now, the second codility task I was faced with was a bit tougher. The goal was to create a function that, given a vector of integers A and an integer K, returned the number of integer pairs in the vector that, when added, sums up to K. Let me give you an example. Assume that you are given a vector A = [0, -1, 3, 2, -5, 7] and K = 2. Possible combinations to get K are (0, 2), (-1, 3), (3, -1), (2, 0),  (-5, 7), and (7, -5). In other words, the function should return 6. Now, how did I solve this task? The first solution that came to mind involved nested for-loops. The outer loop picking one integer at the time from the vector and the inner loop adding the integer to the others one by one to see if the result is K. This solution works, but it does not scale well. Time complexity will be O(N**2) ,   something that for large vectors will result in very long execution times. My second approach was to use my old friend, the integer counter, and count all occurences of each...
2 kommentarer
Läs mer