ภาคผนวก C: เทรตที่ derive ได้
ในหลายส่วนของหนังสือเล่มนี้ เราได้กล่าวถึงแอตทริบิวต์ derive ซึ่งคุณสามารถนำไปใช้งานกับนิยามของ struct หรือ enum ได้ โดยแอตทริบิวต์ derive จะสร้างโค้ดสำหรับอิมพลีเมนต์เทรต (traits) ตามพฤติกรรมเริ่มต้นของเทรตนั้น ๆ ให้กับชนิดข้อมูลที่คุณกำกับด้วยไวยากรณ์ derive โดยอัตโนมัติ
ในภาคผนวกนี้ เรารวบรวมข้อมูลอ้างอิงของเทรตทั้งหมดในไลบรารีมาตรฐานที่คุณสามารถใช้งานร่วมกับ derive ได้ โดยในแต่ละหัวข้อย่อยจะครอบคลุมเนื้อหาดังนี้:
- การ derive เทรตนี้จะเปิดใช้งานตัวดำเนินการและเมธอดใดบ้าง
- โค้ดที่
deriveสร้างขึ้นมาทำหน้าที่อะไรบ้าง - การอิมพลีเมนต์เทรตนี้บ่งบอกถึงคุณสมบัติใดของชนิดข้อมูล
- เงื่อนไขที่อนุญาตหรือไม่อนุญาตให้อิมพลีเมนต์เทรตนั้น
- ตัวอย่างการทำงานที่จำเป็นต้องอาศัยเทรตนั้น
หากคุณต้องการให้มีพฤติกรรมการทำงานที่แตกต่างไปจากที่แอตทริบิวต์ derive จัดเตรียมไว้ โปรดศึกษาเอกสารของไลบรารีมาตรฐาน สำหรับแต่ละเทรต เพื่อดูรายละเอียดวิธีการเขียนโค้ดอิมพลีเมนต์ด้วยตนเอง
เทรตที่ระบุไว้ในบทนี้คือเทรตทั้งหมดในไลบรารีมาตรฐานที่รองรับการอิมพลีเมนต์บนชนิดข้อมูลของคุณผ่าน derive ส่วนเทรตอื่น ๆ ที่นิยามไว้ในไลบรารีมาตรฐานจะไม่มีพฤติกรรมเริ่มต้นที่เหมาะสมในตัวเอง จึงขึ้นอยู่กับคุณที่จะต้องอิมพลีเมนต์เทรตเหล่านั้นให้สอดคล้องกับวัตถุประสงค์การใช้งานของคุณเอง
ตัวอย่างหนึ่งของเทรตที่ไม่สามารถ derive ได้คือ Display ซึ่งมีหน้าที่จัดการการจัดรูปแบบข้อความสำหรับแสดงผลแก่ผู้ใช้งานปลายทาง คุณควรพิจารณาเสมอว่ารูปแบบการแสดงผลที่เหมาะสมสำหรับผู้ใช้ควรเป็นอย่างไร ผู้ใช้ควรเห็นข้อมูลส่วนใดบ้าง? ข้อมูลส่วนใดที่เกี่ยวข้องและเป็นประโยชน์ต่อพวกเขามากที่สุด? ซึ่งคอมไพเลอร์ของ Rust ย่อมไม่อาจล่วงรู้บริบทเหล่านี้ได้ จึงไม่สามารถกำหนดพฤติกรรมเริ่มต้นที่เหมาะสมให้คุณได้โดยอัตโนมัติ
อนึ่ง รายการเทรตที่ derive ได้ในภาคผนวกนี้ไม่ได้จำกัดอยู่เพียงเท่านี้ เนื่องจากไลบรารีภายนอกต่าง ๆ สามารถสร้าง derive สำหรับเทรตของตนเองขึ้นมาได้ ทำให้รายการเทรตที่คุณสามารถใช้ร่วมกับ derive นั้นเปิดกว้างอย่างไร้ขีดจำกัด การสร้าง derive ขึ้นมาเองเกี่ยวข้องกับการเขียนมาโครเชิงกระบวนการ (procedural macros) ซึ่งเราได้อธิบายไว้ในหัวข้อ“มาโคร derive แบบกำหนดเอง” ในบทที่ 20
Debug สำหรับเอาต์พุตของโปรแกรมเมอร์
เทรต Debug ช่วยเปิดใช้งานการจัดรูปแบบสำหรับการดีบัก (debug formatting) ในสตริงจัดรูปแบบ ซึ่งคุณสามารถระบุได้โดยใส่ :? ไว้ภายในตัวแทนค่า {}
เทรต Debug ช่วยให้คุณพิมพ์ค่าของอินสแตนซ์ออกมาเพื่อการตรวจสอบและดีบัก เพื่อให้คุณและนักพัฒนาคนอื่น ๆ สามารถตรวจสอบค่าของอินสแตนซ์ ณ จุดต่าง ๆ ระหว่างที่โปรแกรมกำลังทำงานได้
ตัวอย่างเช่น การใช้งานมาโคร assert_eq! จำเป็นต้องอาศัยเทรต Debug เนื่องจากมาโครนี้จะพิมพ์ค่าของอินสแตนซ์ที่ส่งเข้ามาหากการตรวจสอบความเท่ากันล้มเหลว เพื่อให้นักพัฒนาสามารถมองเห็นได้อย่างชัดเจนว่าทำไมค่าทั้งสองจึงไม่เท่ากัน
PartialEq และ Eq สำหรับการเปรียบเทียบความเท่ากัน
เทรต PartialEq ช่วยให้คุณสามารถเปรียบเทียบอินสแตนซ์ของชนิดข้อมูลเพื่อตรวจสอบความเท่ากัน และเปิดใช้งานตัวดำเนินการ == และ !=
การ derive PartialEq จะสร้างเมธอด eq ขึ้นมา โดยเมื่อ derive บน struct อินสแตนซ์สองตัวจะเท่ากันก็ต่อเมื่อฟิลด์ ทั้งหมด มีค่าเท่ากัน และจะไม่เท่ากันหากมีฟิลด์ ใดฟิลด์หนึ่ง ไม่เท่ากัน ส่วนเมื่อ derive บน enum แต่ละวาเรียนต์จะเท่ากับตัวมันเอง และไม่เท่ากับวาเรียนต์อื่น ๆ
การใช้งานมาโคร assert_eq! จำเป็นต้องอาศัยเทรต PartialEq เพื่อให้สามารถเปรียบเทียบความเท่ากันของอินสแตนซ์ทั้งสองได้
เทรต Eq ไม่มีเมธอดใด ๆ ในตัว หน้าที่ของมันคือการบ่งชี้ว่า ทุก ๆ ค่าของชนิดข้อมูลนั้นจะเท่ากับตัวมันเองเสมอ (reflexive property) โดยเทรต Eq สามารถใช้ได้เฉพาะกับชนิดข้อมูลที่อิมพลีเมนต์ PartialEq อยู่แล้วเท่านั้น ทว่าไม่ใช่ทุกชนิดข้อมูลที่อิมพลีเมนต์ PartialEq จะสามารถอิมพลีเมนต์ Eq ได้ ตัวอย่างเช่น ชนิดข้อมูลตัวเลขทศนิยม (floating-point numbers): ข้อกำหนดของตัวเลขทศนิยมระบุว่าค่า Not-a-Number (NaN) สองค่าจะไม่เท่ากัน
ตัวอย่างการใช้งานที่จำเป็นต้องมี Eq คือการนำชนิดข้อมูลไปใช้เป็นคีย์ใน HashMap<K, V> เพื่อให้ HashMap สามารถตรวจสอบได้ว่าคีย์สองตัวเป็นคีย์เดียวกันจริงหรือไม่
PartialOrd และ Ord สำหรับการเปรียบเทียบการเรียงลำดับ
เทรต PartialOrd ช่วยให้คุณสามารถเปรียบเทียบอินสแตนซ์ของชนิดข้อมูลเพื่อการจัดเรียงลำดับ ชนิดข้อมูลที่อิมพลีเมนต์ PartialOrd จะสามารถใช้ตัวดำเนินการ <, >, <= และ >= ได้ โดยคุณสามารถนำเทรต PartialOrd ไปใช้ได้เฉพาะกับชนิดข้อมูลที่อิมพลีเมนต์ PartialEq อยู่แล้วเท่านั้น
การ derive PartialOrd จะสร้างเมธอด partial_cmp ซึ่งคืนค่าเป็น Option<Ordering> โดยจะมีค่าเป็น None หากค่าที่นำมาเปรียบเทียบไม่สามารถจัดเรียงลำดับกันได้ ตัวอย่างของค่าที่ไม่สามารถเปรียบเทียบเพื่อเรียงลำดับได้แม้ค่าอื่น ๆ ส่วนใหญ่ของชนิดนั้นจะเปรียบเทียบได้ ก็คือค่า NaN ของเลขทศนิยม การเรียกใช้ partial_cmp ระหว่างตัวเลขทศนิยมใด ๆ กับค่า NaN จะได้ผลลัพธ์เป็น None เสมอ
เมื่อ derive บน struct เทรต PartialOrd จะเปรียบเทียบอินสแตนซ์สองตัวโดยเทียบค่าของแต่ละฟิลด์ตามลำดับที่ฟิลด์นั้นปรากฏในนิยามของ struct ส่วนเมื่อ derive บน enum วาเรียนต์ที่ประกาศไว้ก่อนหน้าในนิยามของ enum จะถือว่ามีค่าน้อยกว่าวาเรียนต์ที่ประกาศไว้ทีหลัง
ตัวอย่างการใช้งานที่ต้องอาศัยเทรต PartialOrd เช่น เมธอด gen_range จากเครต rand ซึ่งทำหน้าที่สุ่มค่าตัวเลขในช่วงที่กำหนดผ่านนิพจน์เรนจ์
เทรต Ord บ่งบอกว่า สำหรับสองค่าใด ๆ ของชนิดข้อมูลนั้น จะสามารถเปรียบเทียบเพื่อหาลำดับที่แน่นอนได้เสมอ โดยเทรต Ord จะอิมพลีเมนต์เมธอด cmp ซึ่งคืนค่าเป็น Ordering โดยตรง (ไม่ใช่ Option<Ordering>) เพราะสามารถเปรียบเทียบลำดับได้แน่นอนเสมอ คุณสามารถนำเทรต Ord ไปใช้ได้เฉพาะกับชนิดข้อมูลที่อิมพลีเมนต์ทั้ง PartialOrd และ Eq แล้วเท่านั้น (และ Eq ก็ต้องใช้ PartialEq ด้วย) เมื่อ derive บน struct และ enum เมธอด cmp จะทำงานในลักษณะเดียวกับ partial_cmp ของ PartialOrd
ตัวอย่างการใช้งานที่จำเป็นต้องอาศัย Ord เช่น การจัดเก็บข้อมูลใน BTreeSet<T> ซึ่งเป็นโครงสร้างข้อมูลที่จัดเก็บสมาชิกตามลำดับการเรียงของค่า
Clone และ Copy สำหรับการทำสำเนาค่า
เทรต Clone ช่วยให้คุณสามารถทำสำเนาแบบลึก (deep copy) ของค่าหนึ่งได้อย่างชัดเจน ซึ่งกระบวนการทำสำเนานี้อาจเกี่ยวข้องกับการรันโค้ดใด ๆ และการคัดลอกข้อมูลบนฮีป (heap) ดูรายละเอียดเพิ่มเติมเกี่ยวกับ Clone ได้ในหัวข้อ“ตัวแปรและข้อมูลที่ปฏิสัมพันธ์กันด้วยการโคลน” ในบทที่ 4
การ derive Clone จะสร้างเมธอด clone ขึ้นมา ซึ่งเมื่ออิมพลีเมนต์สำหรับชนิดข้อมูลโดยรวม ก็จะทำการเรียก clone กับแต่ละส่วนประกอบของชนิดข้อมูลนั้นด้วย นั่นหมายความว่าฟิลด์หรือค่าทั้งหมดในชนิดข้อมูลนั้นจะต้องอิมพลีเมนต์ Clone ด้วยเช่นกันจึงจะสามารถ derive Clone ได้
ตัวอย่างกรณีที่จำเป็นต้องใช้ Clone เช่น การเรียกเมธอด to_vec บนสไลซ์ (slice) เนื่องจากสไลซ์ไม่ได้เป็นเจ้าของอินสแตนซ์ที่มันบรรจุอยู่ แต่เวกเตอร์ที่ได้จาก to_vec จำเป็นต้องเป็นเจ้าของอินสแตนซ์เหล่านั้น เมธอด to_vec จึงต้องเรียก clone บนแต่ละสมาชิก ดังนั้นชนิดข้อมูลที่จัดเก็บอยู่ในสไลซ์จึงต้องอิมพลีเมนต์ Clone
เทรต Copy ช่วยให้คุณสามารถทำสำเนาค่าได้ด้วยการคัดลอกเฉพาะข้อมูลบิตที่อยู่บนสแตก (stack) เท่านั้น โดยไม่ต้องรันโค้ดเพิ่มเติมใด ๆ ดูรายละเอียดเพิ่มเติมเกี่ยวกับ Copy ได้ในหัวข้อ“ข้อมูลบนสแตกเท่านั้น: การคัดลอกค่า” ในบทที่ 4
เทรต Copy ไม่ได้นิยามเมธอดใด ๆ ไว้ เพื่อป้องกันไม่ให้นักพัฒนาไปโอเวอร์โหลดเมธอดเหล่านั้นจนละเมิดข้อตกลงที่ว่าต้องไม่มีการรันโค้ดซับซ้อนใด ๆ เกิดขึ้น ด้วยเหตุนี้ นักพัฒนาทุกคนจึงสามารถมั่นใจได้ว่าการคัดลอกค่าของชนิดข้อมูลที่เป็น Copy จะรวดเร็วอย่างยิ่งเสมอ
คุณสามารถ derive Copy บนชนิดข้อมูลใด ๆ ที่ทุกส่วนประกอบอิมพลีเมนต์ Copy อยู่แล้ว โดยชนิดข้อมูลที่อิมพลีเมนต์ Copy จะต้องอิมพลีเมนต์ Clone ด้วยเสมอ เพราะชนิดข้อมูลที่อิมพลีเมนต์ Copy จะมีการอิมพลีเมนต์ Clone แบบพื้นฐานที่ทำหน้าที่เช่นเดียวกับ Copy
เทรต Copy แทบไม่ค่อยมีข้อกำหนดบังคับใช้ ชนิดข้อมูลที่อิมพลีเมนต์ Copy จะได้รับประโยชน์จากการปรับปรุงประสิทธิภาพ ทำให้คุณไม่จำเป็นต้องคอยเรียก clone ช่วยให้โค้ดกระชับขึ้น
ทุกสิ่งที่คุณทำได้ด้วย Copy คุณก็สามารถทำได้ด้วย Clone เช่นกัน เพียงแต่โค้ดอาจทำงานช้ากว่า หรือต้องคอยเรียก clone ในบางจุด
Hash สำหรับการแมปค่าหนึ่งไปยังค่าที่มีขนาดคงที่
เทรต Hash ช่วยให้คุณนำอินสแตนซ์ของชนิดข้อมูลที่มีขนาดใด ๆ มาแปลง (map) ให้เป็นค่าที่มีขนาดคงที่ผ่านฟังก์ชันแฮช (hash function) การ derive Hash จะสร้างเมธอด hash ขึ้นมา ซึ่งจะนำผลลัพธ์จากการเรียก hash บนแต่ละส่วนประกอบของชนิดข้อมูลมารวมเข้าด้วยกัน นั่นหมายความว่าฟิลด์หรือค่าทั้งหมดในชนิดข้อมูลต้องอิมพลีเมนต์ Hash ด้วยจึงจะสามารถ derive Hash ได้
ตัวอย่างกรณีที่ต้องใช้ Hash คือการนำไปใช้เป็นคีย์ใน HashMap<K, V> เพื่อให้สามารถจัดเก็บและค้นหาข้อมูลได้อย่างมีประสิทธิภาพ
Default สำหรับค่าเริ่มต้น
เทรต Default ช่วยให้คุณสร้างค่าเริ่มต้นสำหรับชนิดข้อมูลได้ การ derive Default จะสร้างฟังก์ชัน default ขึ้นมา ซึ่งจะเรียกฟังก์ชัน default บนแต่ละส่วนประกอบของชนิดข้อมูล นั่นหมายความว่าฟิลด์หรือค่าทั้งหมดในชนิดข้อมูลต้องอิมพลีเมนต์ Default ด้วยจึงจะสามารถ derive Default ได้
ฟังก์ชัน Default::default มักนิยมนำมาใช้ร่วมกับไวยากรณ์อัปเดต struct ดังที่ได้กล่าวถึงในหัวข้อ“การสร้างอินสแตนซ์ด้วยไวยากรณ์อัปเดต struct” ในบทที่ 5 คุณสามารถกำหนดค่าเฉพาะให้กับฟิลด์เพียงไม่กี่ฟิลด์ แล้วใช้ค่าเริ่มต้นสำหรับฟิลด์ที่เหลือด้วยคำสั่ง ..Default::default()
ตัวอย่างกรณีที่จำเป็นต้องใช้เทรต Default เช่น การเรียกเมธอด unwrap_or_default บนอินสแตนซ์ของ Option<T> หาก Option<T> มีค่าเป็น None เมธอด unwrap_or_default จะคืนค่าผลลัพธ์ของ Default::default สำหรับชนิดข้อมูล T ที่บรรจุอยู่ใน Option<T> ออกมา