query
On this page

nullOr

lib.types.nullOr

Docs pulled from | This Revision | 18 minutes ago


Nixpkgs manual

types.nullOr t

null or type t. Multiple definitions are merged according to type t.

This is mostly equivalent to either (enum [ null ]) t, but nullOr provides a null fallback for attribute values with mkIf false definitions in lazyAttrsOf (nullOr t), whereas either would throw an error when the attribute is accessed.

Noogle detected

Implementation

The following is the current implementation of this function.

nullOr =
    elemType:
    mkOptionType rec {
      name = "nullOr";
      description = "null or ${
        optionDescriptionPhrase (class: class == "noun" || class == "conjunction") elemType
      }";
      descriptionClass = "conjunction";
      check = {
        __functor = _self: x: x == null || elemType.check x;
        isV2MergeCoherent = true;
      };
      merge = {
        __functor =
          self: loc: defs:
          let
            inherit (self.v2 { inherit loc defs; }) headError value;
          in
          if headError.causedByMixedNulls or false then throw headError.message else value;
        v2 =
          { loc, defs }:
          if all (def: def.value != null) defs then
            # There are no null values
            if elemType.merge ? v2 then
              checkV2MergeCoherence loc elemType (elemType.merge.v2 { inherit loc defs; })
            else
              {
                value = elemType.merge loc defs;
                headError = checkDefsForError elemType.check loc defs;
                valueMeta = { };
              }
          else
            # There are some null values
            {
              headError =
                if length defs == 1 || all (def: def.value == null) defs then
                  null
                else
                  {
                    message = "The option `${showOption loc}` is defined both null and not null, in ${showFiles (getFiles defs)}.";
                    causedByMixedNulls = true;
                  };
              value = null;
              valueMeta = { };
            };
      };
      emptyValue = {
        value = null;
      };
      getSubOptions = elemType.getSubOptions;
      getSubModules = elemType.getSubModules;
      substSubModules = m: nullOr (elemType.substSubModules m);
      functor = (elemTypeFunctor name { inherit elemType; }) // {
        type = payload: lib.types.nullOr payload.elemType;
      };
      nestedTypes.elemType = elemType;
    };