Conventions used

There are a number of text conventions used throughout this book.

Code in text: Indicates code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles. Here is an example: “This should create a buf.yaml file in the proto directory.”

A block of code is set as follows:

syntax = "proto3";
message Encoding {
  int32 i32 = 1;
}

When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:

type Person_PhoneNumber_Type int32
const (
  Person_PhoneNumber_TYPE_UNSPECIFIED  Person_PhoneNumber_Type = 0
  Person_PhoneNumber_TYPE_MOBILE  Person_PhoneNumber_Type = 1
  Person_PhoneNumber_TYPE_HOME  Person_PhoneNumber_Type = 2
  Person_PhoneNumber_TYPE_WORK  Person_PhoneNumber_Type = 3
)

Any command-line input or output is written as follows:

$ cat int32.txtpb | protoc --encode=Encoding encoding.proto | hexdump –C

Bold: Indicates a new term, an important word, or words that you see onscreen. For instance, words in menus or dialog boxes appear in bold. Here is an example: “The structure of the data is called the data format.”

Tips or important notes

Appear like this.