FSharpPlus


NonEmptyMap<'Key, 'Value> Type

A type-safe map that contains at least one element.

Record fields

Record Field Description

Value

Full Usage: Value

Field type: Map<'Key, 'Value>
Field type: Map<'Key, 'Value>

Instance members

Instance member Description

this.Add

Full Usage: this.Add

Parameters:
    key : 'Key
    value : 'Value

Returns: NonEmptyMap<'Key, 'Value>
key : 'Key
value : 'Value
Returns: NonEmptyMap<'Key, 'Value>

this.ContainsKey

Full Usage: this.ContainsKey

Parameters:
    key : 'Key

Returns: bool
key : 'Key
Returns: bool

this[key]

Full Usage: this[key]

Parameters:
    key : 'Key

Returns: 'Value
key : 'Key
Returns: 'Value

this.TryFind

Full Usage: this.TryFind

Parameters:
    key : 'Key

Returns: 'Value option
key : 'Key
Returns: 'Value option

this.TryGetValue

Full Usage: this.TryGetValue

Parameters:
    key : 'Key
    value : byref<'Value>

Returns: bool
key : 'Key
value : byref<'Value>
Returns: bool

Static members

Static member Description

NonEmptyMap.Create(arg1, rest)

Full Usage: NonEmptyMap.Create(arg1, rest)

Parameters:
    arg0 : 'Key * 'Value
    rest : ('Key * 'Value)[]

Returns: NonEmptyMap<'Key, 'Value>
arg0 : 'Key * 'Value
rest : ('Key * 'Value)[]
Returns: NonEmptyMap<'Key, 'Value>

NonEmptyMap.FoldIndexed(x, f, z)

Full Usage: NonEmptyMap.FoldIndexed(x, f, z)

Parameters:
    x : NonEmptyMap<'k, 't>
    f : 'a -> 'k -> 't -> 'a
    z : 'a

Returns: 'a
x : NonEmptyMap<'k, 't>
f : 'a -> 'k -> 't -> 'a
z : 'a
Returns: 'a

NonEmptyMap.Iterate(x, action)

Full Usage: NonEmptyMap.Iterate(x, action)

Parameters:
x : NonEmptyMap<'a, 'b>
action : 'b -> unit

NonEmptyMap.IterateIndexed(x, f)

Full Usage: NonEmptyMap.IterateIndexed(x, f)

Parameters:
x : NonEmptyMap<'K, 'T>
f : 'K -> 'T -> unit

NonEmptyMap.Map(x, mapping)

Full Usage: NonEmptyMap.Map(x, mapping)

Parameters:
Returns: NonEmptyMap<'a, 'u>
x : NonEmptyMap<'a, 'v>
mapping : 'v -> 'u
Returns: NonEmptyMap<'a, 'u>

NonEmptyMap.MapIndexed(x, f)

Full Usage: NonEmptyMap.MapIndexed(x, f)

Parameters:
Returns: NonEmptyMap<'K, 'U>
x : NonEmptyMap<'K, 'T>
f : 'K -> 'T -> 'U
Returns: NonEmptyMap<'K, 'U>

NonEmptyMap.ToList(s, ?_impl)

Full Usage: NonEmptyMap.ToList(s, ?_impl)

Parameters:
Returns: ('a * 'b) list
s : NonEmptyMap<'a, 'b>
?_impl : ToList
Returns: ('a * 'b) list

NonEmptyMap.ToSeq(s, ?_impl)

Full Usage: NonEmptyMap.ToSeq(s, ?_impl)

Parameters:
Returns: seq<'a * 'b>
s : NonEmptyMap<'a, 'b>
?_impl : ToSeq
Returns: seq<'a * 'b>

NonEmptyMap.Traverse(x, f)

Full Usage: NonEmptyMap.Traverse(x, f)

Parameters:
Returns: ^Functor>
Modifiers: inline
x : NonEmptyMap<'K, 'T>
f : 'T -> ^Functor<'U>
Returns: ^Functor>

NonEmptyMap.TraverseIndexed(x, f)

Full Usage: NonEmptyMap.TraverseIndexed(x, f)

Parameters:
Returns: ^Functor>
Modifiers: inline
x : NonEmptyMap<'K, 'T>
f : 'K -> 'T -> ^Functor<'U>
Returns: ^Functor>

NonEmptyMap.Unzip(x)

Full Usage: NonEmptyMap.Unzip(x)

Parameters:
Returns: NonEmptyMap<'K, 'T> * NonEmptyMap<'K, 'U>
x : NonEmptyMap<'K, ('T * 'U)>
Returns: NonEmptyMap<'K, 'T> * NonEmptyMap<'K, 'U>

NonEmptyMap.``+``(x, y, ?_mthd)

Full Usage: NonEmptyMap.``+``(x, y, ?_mthd)

Parameters:
Returns: NonEmptyMap<'a, ^b>
Modifiers: inline
x : NonEmptyMap<'a, ^b>
y : NonEmptyMap<'a, ^b>
?_mthd : Plus
Returns: NonEmptyMap<'a, ^b>