Struct constructor: "fields must be fully assigned before control is returned to the caller."

C#ConstructorStruct

C# Problem Overview


Here is a struct I am trying to write:

  public struct AttackTraits
        {
            public AttackTraits(double probability, int damage, float distance)
            {
                Probability = probability;
                Distance = distance;
                Damage = damage;
            }

            private double probability;
            public double Probability
            {
                get
                {
                    return probability;
                }
                set
                {
                    if (value > 1 || value < 0)
                    {
                        throw new ArgumentOutOfRangeException("Probability values must be in the range [0, 1]");
                    }
                    probability = value;
                }
            }

            public int Damage { get; set; }
            
            public float Distance { get; set; }
        }

This results in the following compilation errors:

> The 'this' object cannot be used > before all of its fields are assigned > to > > Field 'AttackTraits.probability' must > be fully assigned before control is > returned to the caller > > Backing field for automatically > implemented property > 'AttackTraits.Damage' must be fully > assigned before control is returned to > the caller. Consider calling the > default constructor from a constructor > initializer. > > Backing field for automatically > implemented property > 'AttackTraits.Distance' must be fully > assigned before control is returned to > the caller. Consider calling the > default constructor from a constructor > initializer.

What am I doing wrong?

C# Solutions


Solution 1 - C#

If you see this error on a struct that has an automatic property, just call the parameterless contructor from your parameterized one by doing : this() example below:

struct MyStruct
{
  public int SomeProp { get; set; }

  public MyStruct(int someVal) : this()
  {
     this.SomeProp = someVal;
  }
}

By calling :this() from your constructor declaration you let the base ValueType class initialize all the backing fields for the automatic properties. We cannot do it manually on our constructor because we don't have access to the backing field of an automatic property. ValueType is the base class of all structs.

Solution 2 - C#

try to access probability field not accessor. In this case auto-props should work as well.

There is no way for a struct to have parameterless constructor so consider change it to class instead.

Best practise is to use structs only if they are 16 bytes or less and are immutable. So if you are going to change object fields after creating, consider refactoring it to class.

Also, you can change constructor definition to:

construct(params) : this()

this will remove error as well

Solution 3 - C#

You're setting the probability field through the Probability property, but the compiler doesn't know that the property sets the field... so you need to explicitly initialize the probability field itself

public AttackTraits(double probability, int damage, float distance)
{
    this.probability = 0;
    Distance = distance;
    Damage = damage;
}

Solution 4 - C#

Change the line Probability = probability to this.probability = probability

In the future pick a different naming convention for fields as you do for parameters. For example, prefix all fields with an underscore, so you can simply call this:

_probability = probability;

and see easily what's happening.

Solution 5 - C#

try to change struct to class for AttackTraits

public class AttackTraits
        {
.........
        {

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionNick HeinerView Question on Stackoverflow
Solution 1 - C#Chris AmelinckxView Answer on Stackoverflow
Solution 2 - C#vittoreView Answer on Stackoverflow
Solution 3 - C#Thomas LevesqueView Answer on Stackoverflow
Solution 4 - C#David MortonView Answer on Stackoverflow
Solution 5 - C# DemsourceView Answer on Stackoverflow