Back to Questions
963
views3
comments
Forbidden names in variant types
f#

Hello All,

Tried to create following variant today:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

type Result =


  | Ok
  | TreatAsOk


  | DescribedOk of string
  | Fail
  | TreatAsFail
  | DescribedFail of string
  | SpecialCase


with
  member x.IsFail = match x with Fail | TreatAsFail | DescribedFail _ -> true | _ -> false
  member x.IsOk = match x with Ok | TreatAsOk | DescribedOk _ -> true | _ -> false

But this not compiled since "IsFail" clashed with default variant augmentation.
First of all this "Is" prefixed members does`t event visible from F# code and thus you think of "IsFail" as nice name.

Second in my code "IsFail" makes more sense described like this instead of default implementation which just checks for exact match with "Fail". Denying to use certain, perfectly sane, names look quite confusing.
I think it would be better to add field "Tag" with all this properties, instead of adding all of them as members directly.

In C# usage can be following:

1
2
3
4
5
6

var result = FSharpModule.GetResult;


if (result.Tag.IsTreatAsFail) {
  ...
}

or

1
2
3
4
5
6

var result = FSharpModule.GetResult;


if (result.Tag.TreatAsFail) {
...
}
.

Try this:

1
2
3
4
5
6
7
8
9
10
11
12

[<DefaultAugmentation(false)>]
type Result =
  | Ok
  | TreatAsOk
  | DescribedOk of string
  | Fail
  | TreatAsFail
  | DescribedFail of string
  | SpecialCase
with
  member x.IsFail = match x with Fail | TreatAsFail | DescribedFail _ -> true | _ -> false
  member x.IsOk = match x with Ok | TreatAsOk | DescribedOk _ -> true | _ -> false
By on 2/17/2010 11:14 AM ()

Wouldn't 'AsFail' make more sense? or possibly 'IsFailure'? Think about it: you're saying, 'is it any of the failure cases?' Meanwhile, 'IsFail' quite logically identifies an explicit case from the union.

By on 2/17/2010 8:20 PM ()
1

[<DefaultAugmentation(false)>]

That is nice, thank you.

Wouldn't 'AsFail' make more sense? or possibly

'IsFailure'? Think about it: you're saying, 'is it any of the failure

cases?' Meanwhile, 'IsFail' quite logically identifies an explicit case

from the union.

It is definitely possible to use different name, but how should I know in first place about this restrictions? In F# this members not accessible and this makes things confusing. But "IsFailure" will become confusing in C# code, since here you will start to see "IsFail", "IsFailure", "IsTreatAsFail", etc members and distinguish one with exact match from something else can be difficult.

Anyway, this issue just minor irritation, but before CTP become RTM anything is possible, even irritant removal :)

By on 2/18/2010 12:48 AM ()

    Topic tags

    IntelliFactory Offices Copyright (c) 2011-2012 IntelliFactory. All rights reserved.
    Home | Products | Consulting | Trainings | Blogs | Jobs | Contact Us | Terms of Use | Privacy Policy | Cookie Policy     		Built with WebSharper