---
title: "Fields"
url: https://docs.zeroc.com/ice/3.8/slice/fields
language: ruby
docs_index: https://docs.zeroc.com/llms.txt
---

> For an index of every page, see [llms.txt](https://docs.zeroc.com/llms.txt).

# Fields

Programming language: Ruby. Other languages: [C++](https://docs.zeroc.com/ice/3.8/slice/fields/cpp.md), [C#](https://docs.zeroc.com/ice/3.8/slice/fields/csharp.md), [Java](https://docs.zeroc.com/ice/3.8/slice/fields/java.md), [JavaScript](https://docs.zeroc.com/ice/3.8/slice/fields/js.md), [MATLAB](https://docs.zeroc.com/ice/3.8/slice/fields/matlab.md), [PHP](https://docs.zeroc.com/ice/3.8/slice/fields/php.md), [Python](https://docs.zeroc.com/ice/3.8/slice/fields/python.md), [Swift](https://docs.zeroc.com/ice/3.8/slice/fields/swift.md).

## Syntax

A field is defined as `Type name`, where `Type` is the field's type and `name` is the field's name. For example:

```slice
string name;
ByteSeq image;
Fruit fruit;
```

The type of a field can be a [basic type](https://docs.zeroc.com/ice/3.8/slice/basic-types/ruby.md), a [user-defined type](https://docs.zeroc.com/ice/3.8/slice/user-defined-types.md), `Object*` (an untyped proxy), or `Value` (an untyped class instance).

## Nullable and Non-Nullable Fields

Fields with proxy and class types are nullable: they can hold null. Fields of other types always hold a value, unless they are [optional fields](#optional-fields) that are not set.

```slice
struct Example
{
    int count; // must be set
    Greeter* greeter; // proxy type, so it can be null
    Node node; // class type, so it can be null
}
```

## Optional Fields

A field of a Slice [class](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/classes/ruby.md) or [exception](https://docs.zeroc.com/ice/3.8/slice/exceptions/ruby.md) may be declared as optional to indicate that a program can leave its value unset. Fields not declared as optional are known as *required* fields.

Each optional field must be assigned a unique, non-negative integer *tag*:

```slice
module M
{
    class C
    {
        string name;
        bool active;
        optional(2) string alternateName;
        optional(5) int overrideCode;
    }
}
```

The scope of a tag is the class or exception that defines the field, and this class or exception only: a derived class or exception can reuse a tag of its base type. For example:

```slice
exception BaseException
{
    optional(1) int systemCode;
}

exception DerivedException extends BaseException
{
    optional(1) string diagnostic; // OK: a different scope
}
```

Optional and required fields can be interleaved, and their tags can be in any order. The tag identifies the field in the [encoding](https://docs.zeroc.com/ice/3.8/encoding/data-encoding-for-optional-values.md); the language mappings do not expose it.

An optional field cannot have a class type, or a constructed type that holds a class type.

## Default Values

You can specify a default value for a field that has one of the following types:

- An [integral](https://docs.zeroc.com/ice/3.8/slice/basic-types/ruby.md) type (`byte`, `short`, `int`, `long`)
- A [floating point](https://docs.zeroc.com/ice/3.8/slice/basic-types/ruby.md) type (`float` or `double`)
- [string](https://docs.zeroc.com/ice/3.8/slice/basic-types/ruby.md)
- [bool](https://docs.zeroc.com/ice/3.8/slice/basic-types/ruby.md)
- [enum](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/ruby.md)

For example:

```slice
struct Location
{
    string name;
    Point pt;
    bool display = true;
    string source = "GPS";
}
```

The legal syntax for literal values is the same as for Slice [constants](https://docs.zeroc.com/ice/3.8/slice/constants-and-literals/ruby.md), and you may also use a constant as a default value. The language mapping guarantees that fields are initialized to their declared default values using a language-specific mechanism.

You can declare a default value for optional fields just as you can for required fields:

```slice
class C
{
    string name;
    bool active = true;
    optional(2) string alternateName;
    optional(5) int overrideCode = -1;
}
```

An optional field with a default value is considered to be set by default.

## Language Mapping

A Slice field maps to a Ruby instance variable with the same name, plus accessors to read and write this instance variable.

For example:

```slice
class Address { ... }

struct Person
{
    string name;
    Address address;
}
```

maps to:

```ruby
class Address < Ice::Value
    ...
end

class Person
    attr_accessor :name, :address

    def initialize(name='', address=nil)
        @name = name
        @address = address
    end
    ...
end
```

### Optional Fields {#language-mapping-optional-fields}

An optional field maps to a Ruby instance variable and accessors, just like a non-optional field.

For example:

```slice
class C
{
    optional(2) string alternateName;
    optional(5) int overrideCode;
    optional(1) Widget* favoriteWidgetProxy;
}
```

maps to:

```ruby
class C < Ice::Value
    attr_accessor :alternateName, :overrideCode, :favoriteWidgetProxy

    def initialize(alternateName=Ice::Unset, overrideCode=Ice::Unset, favoriteWidgetProxy=Ice::Unset)
        @alternateName = alternateName
        @overrideCode = overrideCode
        @favoriteWidgetProxy = favoriteWidgetProxy
    end
end
```

The default value for optional fields is `Ice::Unset`; it represents the “not set” value.

### Default Values {#language-mapping-default-values}

Slice default values map to default values in the mapped `initialize` method.

For example:

```slice
struct Location
{
    string name;
    Point point;
    bool display = true;
    string source = "GPS";
}
```

maps to:

```ruby
class Location
    attr_accessor :name, :point, :display, :source

    def initialize(name='', point=::Example::Point.new, display=true, source="GPS")
        @name = name
        @point = point
        @display = display
        @source = source
    end

    # ...
end
```

When you don’t define a default value in Slice, and you initialize a field without providing a value for this field, the generated code uses the following default:

| **Optional Field?** | **Slice Field Type** | **Default Ruby Value** |
| --- | --- | --- |
| No | `string` | Empty string |
|  | `enum` | First enumerator in enumeration |
|  | `struct` | New instance created with no argument |
|  | Numeric | `0` |
|  | `bool` | `false` |
|  | `sequence`, `dictionary`, `class`, proxy | `nil` |
| Yes | Any | `Ice::Unset` |
