Bahasa Pemrograman Rust

Lampiran C: Derivable Traits (Trait yang Bisa Di-derive)

Di berbagai tempat di buku ini, kita udah ngebahas atribut derive, yang mana bisa kita sematkan ke definisi struct atau enum. Atribut derive ini bakal menghasilkan kode yang mengimplementasikan (implement) sebuah trait lengkap dengan implementasi default (bawaan)-nya pada tipe yang udah kita anotasi (annotated) memakai sintaks derive tersebut.

Di lampiran ini, kita menyediakan referensi dari semua traits di standard library yang mana bisa kita pakai dengan atribut derive. Masing-masing bagian mencakup:

• Operator dan method apa saja yang bakal difungsikan (enable) dengan nge-derive trait ini
• Apa saja yang dilakukan sama implementasi trait yang disediain oleh derive tersebut
• Apa makna (signifies) dari mengimplementasikan trait tersebut bagi tipe kita
• Persyaratan dan kondisi di mana kita dibolehkan atau tidak dibolehkan buat mengimplementasikan trait ini
• Contoh-contoh operasi yang mewajibkan adanya trait ini

Kalau kita pengen mendapatkan perilaku yang berbeda dari yang disediain sama atribut derive, silakan cek dokumentasi standard library buat setiap trait demi mendapatkan detail soal gimana caranya buat mengimplementasikan mereka secara manual.

Trait-trait yang terdaftar di sini adalah satu-satunya trait yang didefinisikan sama standard library yang bisa diimplementasikan ke tipe kita memakai derive. Trait lain yang didefinisikan di standard library itu tidak punya perilaku bawaan (default) yang masuk akal (sensible), jadinya itu semua tergantung kita buat mengimplementasikannya pakai cara yang paling masuk akal sejalan dengan apa yang mau kita capai.

Contoh dari sebuah trait yang tidak bisa di-derive adalah Display, yang mana bertugas menangani format teks buat para pengguna akhir (end users). Kita harus selalu mempertimbangkan cara yang paling pantas buat menampilkan sebuah tipe ke end user. Bagian mana aja dari tipe tersebut yang boleh dilihat sama end user? Bagian mana aja yang bakal mereka anggap relevan? Format data kayak gimana yang bakal paling gampang dimengerti sama mereka? Compiler Rust tidak punya wawasan (insight) kayak gini, jadinya dia tidak bisa menyediakan perilaku default yang pantas buat kita.

Daftar derivable traits (trait yang bisa di-derive) yang disediain di lampiran ini itu tidaklah komprehensif: libraries lain bisa aja ngimplementasiin derive buat trait mereka sendiri, ngebikin daftar trait yang bisa kita pakai dengan derive itu bener-bener jadi tanpa batas (open-ended). Mengimplementasikan derive ini melibatkan pemakaian procedural macro, yang mana udah dibahas di bagian “Custom derive Macros” di Bab 20.

Debug Buat Output Programmer

Trait Debug memfungsikan (enables) pemformatan debug di dalem format strings, yang mana bisa kita indikasikan dengan nambahin sisipan :? ke dalem kurung kurawal {} (placeholders).

Trait Debug ngasih kita kebebasan buat mencetak instances dari sebuah tipe buat tujuan debugging (pemeriksaan error), supaya kita dan programmer lainnya yang lagi makek tipe kita tersebut bisa menginspeksi instance tersebut pas ada di satu titik tertentu di program pas lagi dieksekusi.

Trait Debug diwajibkan, misalnya, saat kita menggunakan macro assert_eq!. Macro ini akan mencetak nilai-nilai dari instances yang diberikan kepadanya sebagai argumen jika equality assertion gagal sehingga para programmer bisa melihat dengan jelas alasan mengapa kedua instance tersebut tidak sama.

PartialEq dan Eq Buat Perbandingan Kesamaan (Equality Comparisons)

Trait PartialEq ngasih kita kemungkinan buat ngebandingin instances dari sebuah tipe buat mengecek apakah mereka itu sama atau tidak, dan juga memfungsikan pemakaian operator == dan !=.

Nge-derive PartialEq bakal mengimplementasikan method eq. Pas PartialEq di-derive pada structs, dua instances dianggap sama hanya jika semua fields-nya sama, dan kedua instances itu bakal dianggap tidak sama kalau ada field apa pun yang tidak sama. Saat di-derive pada enums, masing-masing varian bakal dianggap sama dengan dirinya sendiri dan tidak sama dengan varian lainnya.

Trait PartialEq diwajibkan, misalnya, pas lagi memakai macro assert_eq!, yang mana dia perlu bisa ngebandingin dua buah instances dari suatu tipe buat ngelihat apakah mereka sama (equality).

Trait Eq tidak punya method apa-apa. Tujuannya adalah sekadar buat ngasih tanda (signal) bahwa untuk setiap nilai dari tipe yang dianotasi, nilai itu dijamin pasti sama dengan dirinya sendiri. Trait Eq ini cuma bisa diterapin (applied) ke tipe-tipe yang juga mengimplementasikan PartialEq, walaupun tidak semua tipe yang mengimplementasikan PartialEq itu otomatis bisa mengimplementasikan Eq. Salah satu contohnya adalah pada tipe floating point number: implementasi perbandingan buat angka floating point menyatakan kalau dua instances dari nilai not-a-number (NaN) itu tidaklah sama (not equal) dengan satu sama lain.

Salah satu contoh kasus di mana Eq diwajibkan adalah untuk keys (kunci) di dalem sebuah HashMap<K, V> supaya si HashMap<K, V> ini bisa ngebedain apakah dua keys yang ada itu benar-benar sama (same) atau tidak.

PartialOrd dan Ord Buat Perbandingan Pengurutan (Ordering Comparisons)

Trait PartialOrd memungkinkan kita buat membandingkan instances dari suatu tipe buat keperluan sorting (pengurutan). Sebuah tipe yang mengimplementasikan PartialOrd bisa dipakai dengan operator <, >, <=, dan >=. Kita cuma bisa memakai atribut trait PartialOrd ini ke tipe-tipe yang juga udah mengimplementasikan PartialEq.

Nge-derive PartialOrd bakal mengimplementasikan method partial_cmp, yang bakal mengembalikan sebuah Option<Ordering> yang mana isinya bakal berupa None kalau nilai-nilai yang dikasih itu ternyata gagal memproduksi sebuah urutan (ordering). Contoh dari sebuah nilai yang gagal memproduksi urutan, sekalipun sebagian besar nilai di tipe tersebut aslinya bisa dibandingin, adalah nilai not-a-number (NaN) pada floating point. Manggil partial_cmp memakai angka floating-point mana pun dicampur dengan nilai NaN floating-point pasti bakal mengembalikan None.

Saat di-derive pada structs, PartialOrd ngebandingin dua buah instances dengan cara ngebandingin setiap nilai di dalam tiap fields-nya berdasarkan dengan urutan kemunculan fields tersebut di saat struct-nya didefinisikan (struct definition). Saat di-derive pada enums, varian-varian enum yang dideklarasikan (muncul) lebih awal di dalam definisi enum bakal dianggap lebih kecil (less than) ketimbang varian-varian yang muncul belakangan.

Trait PartialOrd diwajibkan, misalnya, buat pemakaian method gen_range dari crate rand yang tugasnya menghasilkan nilai acak di dalem jangkauan (range) yang udah dispesifikasikan pakai ekspresi range.

Trait Ord ngasih tahu kita kalau, untuk sembarang dua nilai apa pun dari tipe yang udah dianotasi, pastilah selalu ada sebuah sistem pengurutan yang valid yang bakal eksis (exist). Trait Ord mengimplementasikan method cmp, yang mengembalikan sebuah tipe Ordering dan bukan Option<Ordering> karena sebuah pengurutan yang valid itu bakal selalu dijamin selalu mungkin buat terjadi. Kita cuma boleh naruh atribut trait Ord ke tipe yang mana juga udah mengimplementasikan PartialOrd sekaligus Eq (dan perlu diingat kalau Eq juga mewajibkan adanya PartialEq). Saat di-derive pada structs dan enums, method cmp bakal beroperasi (behaves) pakai cara yang sama persis kayak apa yang dilakuin sama implementasi yang di-derive untuk method partial_cmp yang ada di dalam PartialOrd.

Salah satu contoh pas Ord diwajibkan (required) adalah saat kita mau nyimpen nilai-nilai ke dalam sebuah BTreeSet<T>, yaitu struktur data yang nyimpen data berdasarkan urutan sort (pengurutan) dari nilai-nilai tersebut.

Clone dan Copy Buat Menduplikasi Nilai (Duplicating Values)

Trait Clone membiarkan kita secara eksplisit ngebikin deep copy (salinan mendalam) dari sebuah nilai, dan proses duplikasi ini juga bisa jadi ngelibatin pengeksekusian (running) kode apa pun dan penyalinan data heap. Silakan lihat bagian “Variabel dan Data Berinteraksi dengan Clone” di Bab 4 buat informasi lebih jauh soal Clone.

Nge-derive Clone bakal mengimplementasikan method clone, yang mana saat diimplementasikan buat keseluruhan tipe, dia bakal memanggil clone juga secara beruntun pada masing-masing komponen dari tipe tersebut. Artinya semua fields atau bagian nilai yang ada di tipe tersebut harus mutlak udah mengimplementasikan Clone juga supaya tipe utamanya bisa nge-derive Clone.

Sebuah contoh kapan Clone diwajibkan adalah pas kita lagi manggil method to_vec pada sebuah slice. Si slice ini kan emang tidak ngantongin (doesn’t own) instances dari tipe yang disimpennya, tapi vector yang dikembalikan dari panggilan to_vec itu jelas butuh dan wajib punya hak milik (own) buat instances yang ada di dalemnya, makanya si to_vec ini bakal manggil method clone buat setiap item yang ada. Dengan demikian, tipe yang disimpan di dalam slice tersebut wajib mengimplementasikan Clone.

Trait Copy membiarkan kita buat menduplikasi sebuah nilai cuma dengan cara meng-copy bits yang ada di dalam memori stack aja; jadinya tidak perlu ada pengeksekusian kode tambahan apa-apa di sini. Lihat bagian “Stack-Only Data: Copy” di Bab 4 buat informasi lebih jauh soal Copy.

Trait Copy ini sama sekali tidak mendefinisikan method apa pun karena tujuannya itu buat mencegah (prevent) para programmer dari nge-overload method tersebut dan ngelanggar (violating) asumsi mutlak bahwa tidak ada eksekusi kode acak apa pun yang berjalan selama proses duplikasi ini. Dengan cara kayak gini, semua programmer bisa berasumsi dengan aman (assume) kalau aksi meng-copy sebuah nilai yang punya trait ini bakal kerasa cepet sekali (very fast).

Kita bisa nge-derive Copy pada tipe apa pun yang mana semua elemen komponennya itu udah mengimplementasikan Copy. Tipe yang udah mengimplementasikan Copy juga wajib mutlak mengimplementasikan Clone, karena sebuah tipe yang mengimplementasikan Copy otomatis udah punya implementasi buat Clone yang sepele (trivial implementation) yang menunaikan tugas yang sama persis kayak Copy tersebut.

Trait Copy itu jarang sekali diwajibkan secara eksplisit; tapi tipe-tipe yang mengimplementasikan Copy punya privilese ketersediaan buat dioptimasi (optimizations available), yang artinya kita jadinya tidak perlu rajin-rajin ngetik manggil clone, yang mana ngebikin kodenya jadi lebih padat (concise) dan ringkas.

Segala apa pun yang bisa dicapai (possible) pakai Copy tentu juga bisa kita capai (accomplish) dengan memakai Clone, tapi ya kodenya itu mungkin bisa jadi agak lebih lelet (slower) atau menuntut keharusan buat manggil clone di mana-mana (in places).

Hash Buat Memetakan Nilai ke Nilai Lain Berukuran Tetap (Fixed Size)

Trait Hash ngasih kita kapabilitas buat ngambil instance dari sebuah tipe dengan ukuran yang sembarang (arbitrary size) lalu memetakan (map) instance tersebut menjadi sebuah nilai yang punya ukuran tetap (fixed size) menggunakan sebuah fungsi hash. Nge-derive Hash bakal mengimplementasikan method hash. Implementasi derived dari method hash ini bakal ngegabungin (combines) seluruh hasil dari pemanggilan method hash ke setiap komponen (parts) dari tipe tersebut, yang artinya bahwa semua fields atau nilai yang ada di dalem tipe ini wajib juga udah mengimplementasikan Hash supaya si tipe utamanya ini bisa di-derive sama Hash.

Contoh dari kasus di mana Hash diwajibkan (required) adalah pas kita mau nyimpen keys (kunci) di dalam koleksi HashMap<K, V> buat tujuan menyimpen data secara lebih efisien (efficiently).

Default Buat Pembuatan Nilai Bawaan (Default Values)

Trait Default ngebolehin kita buat ngebikin nilai bawaan (default value) buat sebuah tipe. Nge-derive Default bakal mengimplementasikan fungsi default. Implementasi turunan (derived implementation) dari fungsi default ini bakal ngerjain tugasnya dengan cara ikut-ikutan manggil fungsi default buat setiap komponen/elemen dari tipe tersebut, yang mana tentu artinya semua fields atau bagian-bagian nilai di dalam tipe tersebut juga diwajibkan (must also) buat udah mengimplementasikan Default biar tipe utamanya bisa nge-derive trait Default.

Fungsi Default::default ini umumnya sering dipakai digabungin barengan sama sintaks pembaruan struct (struct update syntax) yang pernah kita obrolin di bagian “Ngebikin Instances dari Instances Lain dengan Struct Update Syntax” di Bab 5. Kita bisa mengkustomisasi beberapa fields tertentu aja dari sebuah struct dan sesudahnya itu mengatur (set) lalu memakai nilai default bawaannya buat ngisi sisa bidang-bidang (rest of the fields) yang belum diisi dengan cara memakai ..Default::default().

Trait Default diwajibkan saat kita memakai method unwrap_or_default pada instances dari tipe Option<T>, contohnya. Kalau nilai Option<T>-nya ternyata adalah None, method unwrap_or_default ini nantinya bakal nge-return (ngembaliin) hasil tebakan tebasan yang asalnya dari panggilan Default::default buat si tipe T yang lagi disimpen di dalam Option<T> tersebut.