pillars-core
API
Generated with
pillars-core/pillars/PillarsError/Message

Message

pillars.PillarsError.Message
object Message extends RefinedTypeOps[String, MessageConstraint, Message]

Attributes

Graph
Supertypes
trait RefinedTypeOps[String, MessageConstraint, Message]
class Object
trait Matchable
class Any
Self type
Message.type

Members list

Value members

Inherited methods

inline def apply(value: IronType[String, MessageConstraint]): Message

Implicitly refine at compile-time the given value.

Implicitly refine at compile-time the given value.

Type parameters

A

the refined type.

C

the constraint applied to the type.

Value parameters

value

the value to refine.

Attributes

Returns

the given value typed as IronType

Note

This method ensures that the value satisfies the constraint. If it doesn't or isn't evaluable at compile-time, the compilation is aborted.

Inherited from:
RefinedTypeOps
inline def applyAllUnsafe[F[_]](wrapper: F[String])(using mapLogic: MapLogic[F]): F[Message]

Refine the given value(s) at runtime.

Refine the given value(s) at runtime.

Attributes

Returns

the given values as T.

Throws
IllegalArgumentException

if the constraint is not satisfied.

See also

applyUnsafe.

Inherited from:
RefinedTypeOps
inline def assume(value: String): Message

Refine the given value, assuming the constraint holds.

Refine the given value, assuming the constraint holds.

Attributes

Returns

a constrained value, without performing constraint checks.

See also

assumeAll, apply, applyUnsafe.

Inherited from:
RefinedTypeOps
inline def assumeAll[F[_]](wrapper: F[String]): F[Message]

Refine the given value(s), assuming the constraint holds.

Refine the given value(s), assuming the constraint holds.

Attributes

Returns

a wrapper of constrained values, without performing constraint checks.

See also

assume.

Inherited from:
RefinedTypeOps
def either(value: String): Either[String, Message]

Refine the given value at runtime, resulting in an Either.

Refine the given value at runtime, resulting in an Either.

Attributes

Returns

a Right containing this value as T or a Left containing the constraint message.

See also

fromIronType, option, applyUnsafe.

Inherited from:
RefinedTypeOps
inline def eitherAll[F[_]](wrapper: F[String])(using mapLogic: MapLogic[F]): Either[String, F[Message]]

Refine the given value(s) at runtime, resulting in an Either.

Refine the given value(s) at runtime, resulting in an Either.

Attributes

Returns

a Right containing the given values as T or a Left containing the constraint message.

See also

either.

Inherited from:
RefinedTypeOps
def option(value: String): Option[Message]

Refine the given value at runtime, resulting in an Option.

Refine the given value at runtime, resulting in an Option.

Attributes

Returns

an Option containing this value as T or None.

See also

fromIronType, either, applyUnsafe.

Inherited from:
RefinedTypeOps
inline def optionAll[F[_]](wrapper: F[String])(using mapLogic: MapLogic[F]): Option[F[Message]]

Refine the given value at runtime, resulting in an Option.

Refine the given value at runtime, resulting in an Option.

Attributes

Returns

an Option containing the refined values as F[T] or None.

See also

option.

Inherited from:
RefinedTypeOps
inline def rtc: RuntimeConstraint[String, MessageConstraint]

The runtime constraint of the underlying IronType. Can be used in non-inline methods and to improve runtime performances.

The runtime constraint of the underlying IronType. Can be used in non-inline methods and to improve runtime performances.

Attributes

Inherited from:
RefinedTypeOps
def unapply(value: Message): Option[IronType[String, MessageConstraint]]

Attributes

Inherited from:
RefinedTypeOps

Givens

Inherited givens

inline given given_Mirror_T: given_Mirror_T

Attributes

Inherited from:
RefinedTypeOps
given given_TypeTest_L_T[L](using test: TypeTest[L, String]): given_TypeTest_L_T[L]

Attributes

Inherited from:
RefinedTypeOps
inline given given_TypeTest_T_R[R]: TypeTest[Message, R]

Attributes

Inherited from:
RefinedTypeOps

Extensions

Inherited extensions

extension (wrapper: Message)
inline def value: IronType[String, MessageConstraint]

Attributes

Inherited from:
RefinedTypeOps
Generated with