Documentation
¶
Overview ¶
Package pb holds Protobuf schema for Shiller market data.
Index ¶
- Variables
- type Cents
- type Cents_builder
- type Date
- func (x *Date) ClearMonth()
- func (x *Date) ClearYear()
- func (x *Date) GetMonth() int32
- func (x *Date) GetYear() int32
- func (x *Date) HasMonth() bool
- func (x *Date) HasYear() bool
- func (*Date) ProtoMessage()
- func (x *Date) ProtoReflect() protoreflect.Message
- func (x *Date) Reset()
- func (x *Date) SetMonth(v int32)
- func (x *Date) SetYear(v int32)
- func (x *Date) String() string
- type Date_builder
- type Market
- type Market_builder
- type Quote
- func (x *Quote) ClearCpi()
- func (x *Quote) ClearDividend()
- func (x *Quote) ClearEarnings()
- func (x *Quote) ClearSpComposite()
- func (x *Quote) GetCpi() *Cents
- func (x *Quote) GetDividend() *Cents
- func (x *Quote) GetEarnings() *Cents
- func (x *Quote) GetSpComposite() *Cents
- func (x *Quote) HasCpi() bool
- func (x *Quote) HasDividend() bool
- func (x *Quote) HasEarnings() bool
- func (x *Quote) HasSpComposite() bool
- func (*Quote) ProtoMessage()
- func (x *Quote) ProtoReflect() protoreflect.Message
- func (x *Quote) Reset()
- func (x *Quote) SetCpi(v *Cents)
- func (x *Quote) SetDividend(v *Cents)
- func (x *Quote) SetEarnings(v *Cents)
- func (x *Quote) SetSpComposite(v *Cents)
- func (x *Quote) String() string
- type Quote_builder
- type Record
- func (x *Record) ClearDate()
- func (x *Record) ClearQuote()
- func (x *Record) GetDate() *Date
- func (x *Record) GetQuote() *Quote
- func (x *Record) HasDate() bool
- func (x *Record) HasQuote() bool
- func (*Record) ProtoMessage()
- func (x *Record) ProtoReflect() protoreflect.Message
- func (x *Record) Reset()
- func (x *Record) SetDate(v *Date)
- func (x *Record) SetQuote(v *Quote)
- func (x *Record) String() string
- type Record_builder
Constants ¶
This section is empty.
Variables ¶
View Source
var File_market_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Cents ¶
type Cents struct {
XXX_raceDetectHookData protoimpl.RaceDetectHookData
XXX_presence [1]uint32
// contains filtered or unexported fields
}
Cents is the smallest unit of values. Use it instead of floating numbers to remove error accumulation. Next ID: 2
func (*Cents) ClearCents ¶
func (x *Cents) ClearCents()
func (*Cents) ProtoMessage ¶
func (*Cents) ProtoMessage()
func (*Cents) ProtoReflect ¶
func (x *Cents) ProtoReflect() protoreflect.Message
type Cents_builder ¶
type Cents_builder struct {
// cents is the total value.
Cents *int32
// contains filtered or unexported fields
}
func (Cents_builder) Build ¶
func (b0 Cents_builder) Build() *Cents
type Date ¶
type Date struct {
XXX_raceDetectHookData protoimpl.RaceDetectHookData
XXX_presence [1]uint32
// contains filtered or unexported fields
}
Date is a year-month pair. Next ID: 3
func (*Date) ClearMonth ¶
func (x *Date) ClearMonth()
func (*Date) ProtoMessage ¶
func (*Date) ProtoMessage()
func (*Date) ProtoReflect ¶
func (x *Date) ProtoReflect() protoreflect.Message
type Date_builder ¶
type Date_builder struct {
// year is the year of the date.
Year *int32
// month is the month of the date.
Month *int32
// contains filtered or unexported fields
}
func (Date_builder) Build ¶
func (b0 Date_builder) Build() *Date
type Market ¶
type Market struct {
// contains filtered or unexported fields
}
Market is historical market data. A single record corresponds to one date. Data should not have date gaps. Next ID: 2
func (*Market) GetRecords ¶
func (*Market) ProtoMessage ¶
func (*Market) ProtoMessage()
func (*Market) ProtoReflect ¶
func (x *Market) ProtoReflect() protoreflect.Message
func (*Market) SetRecords ¶
type Market_builder ¶
type Market_builder struct {
// records are market data, one per date.
Records []*Record
// contains filtered or unexported fields
}
func (Market_builder) Build ¶
func (b0 Market_builder) Build() *Market
type Quote ¶
type Quote struct {
// contains filtered or unexported fields
}
Quote summarizes market. Next ID: 5
func (*Quote) ClearDividend ¶
func (x *Quote) ClearDividend()
func (*Quote) ClearEarnings ¶
func (x *Quote) ClearEarnings()
func (*Quote) ClearSpComposite ¶
func (x *Quote) ClearSpComposite()
func (*Quote) GetDividend ¶
func (*Quote) GetEarnings ¶
func (*Quote) GetSpComposite ¶
func (*Quote) HasDividend ¶
func (*Quote) HasEarnings ¶
func (*Quote) HasSpComposite ¶
func (*Quote) ProtoMessage ¶
func (*Quote) ProtoMessage()
func (*Quote) ProtoReflect ¶
func (x *Quote) ProtoReflect() protoreflect.Message
func (*Quote) SetDividend ¶
func (*Quote) SetEarnings ¶
func (*Quote) SetSpComposite ¶
type Quote_builder ¶
type Quote_builder struct {
// sp_composite is the value of S&P composite index.
SpComposite *Cents
// dividend is the dividends payhout for S&P composite index.
Dividend *Cents
// earnings are S&P composite index earnings.
Earnings *Cents
// cpi is consumer price index.
Cpi *Cents
// contains filtered or unexported fields
}
func (Quote_builder) Build ¶
func (b0 Quote_builder) Build() *Quote
type Record ¶
type Record struct {
// contains filtered or unexported fields
}
Record describes market on a single date. Next ID: 3
func (*Record) ClearQuote ¶
func (x *Record) ClearQuote()
func (*Record) ProtoMessage ¶
func (*Record) ProtoMessage()
func (*Record) ProtoReflect ¶
func (x *Record) ProtoReflect() protoreflect.Message
type Record_builder ¶
type Record_builder struct {
// date is the record date.
Date *Date
// quote is the market summary.
Quote *Quote
// contains filtered or unexported fields
}
func (Record_builder) Build ¶
func (b0 Record_builder) Build() *Record
Click to show internal directories.
Click to hide internal directories.