Morgan-Stanley / morphir-elm / Morphir.IR.AccessControlled

Module to manage access to a node in the IR. This is only used to declare access levels not to enforce them. Enforcement can be done through the helper functions withPublicAccess and withPrivateAccess but it's up to the consumer of the API to call the righ function.


type alias AccessControlled a =
{ access : Access
, value : a 
}

Type that represents different access levels.


type Access
    = Public
    | Private

Public or private access.

Creation

public : a -> AccessControlled a

Mark a node as public access. Actors with both public and private access are allowed to see.

private : a -> AccessControlled a

Mark a node as private access. Only actors with private access level can see.

Query

withPublicAccess : AccessControlled a -> Maybe a

Get the value with public access level. Will return Nothing if the value is private.

withPublicAccess (public 13) -- Just 13

withPublicAccess (private 13) -- Nothing

withPrivateAccess : AccessControlled a -> a

Get the value with private access level. Will always return the value.

withPrivateAccess (public 13) -- 13

withPrivateAccess (private 13) -- 13

Transform

map : (a -> b) -> AccessControlled a -> AccessControlled b

Apply a function to the access controlled value but keep the access unchanged.