1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
//! Types and Traits for wrapping Rust types as Ruby objects.
//!
//! This, along with [`RTypedData`], provides a Rust API to the
//! `rb_data_typed_object_wrap` function from Ruby's C API.
use std::{
collections::hash_map::DefaultHasher,
ffi::{c_void, CStr},
fmt,
hash::Hasher,
marker::PhantomData,
mem::size_of_val,
ops::Deref,
panic::catch_unwind,
ptr,
};
#[cfg(ruby_gte_3_0)]
use rb_sys::rbimpl_typeddata_flags::{self, RUBY_TYPED_FREE_IMMEDIATELY, RUBY_TYPED_WB_PROTECTED};
use rb_sys::{
self, rb_data_type_struct__bindgen_ty_1, rb_data_type_t, rb_obj_reveal,
rb_singleton_class_attached, rb_singleton_class_clone, size_t, VALUE,
};
#[cfg(ruby_lt_3_0)]
const RUBY_TYPED_FREE_IMMEDIATELY: u32 = 1;
#[cfg(ruby_lt_3_0)]
const RUBY_TYPED_WB_PROTECTED: u32 = rb_sys::ruby_fl_type::RUBY_FL_WB_PROTECTED as u32;
use crate::{
class::RClass,
error::{bug_from_panic, Error},
gc,
into_value::IntoValue,
object::Object,
r_typed_data::RTypedData,
scan_args::{get_kwargs, scan_args},
try_convert::TryConvert,
value::{
private::{self, ReprValue as _},
ReprValue, Value,
},
Ruby,
};
/// A C struct containing metadata on a Rust type, for use with the
/// `rb_data_typed_object_wrap` API.
#[repr(transparent)]
pub struct DataType(rb_data_type_t);
impl DataType {
/// Create a new `DataTypeBuilder`.
///
/// `name` should be unique per wrapped type. It does not need to be a
/// valid Ruby identifier.
///
/// See [`data_type_builder`](macro@crate::data_type_builder) to create a
/// `DataTypeBuilder` with a `'static CStr` `name` from a string literal.
pub const fn builder<T>(name: &'static CStr) -> DataTypeBuilder<T>
where
T: DataTypeFunctions,
{
DataTypeBuilder::new(name)
}
#[inline]
pub(crate) fn as_rb_data_type(&self) -> &rb_data_type_t {
&self.0
}
}
unsafe impl Send for DataType {}
unsafe impl Sync for DataType {}
/// A helper trait used to define functions associated with a [`DataType`].
pub trait DataTypeFunctions
where
Self: Send + Sized,
{
/// Called when the Ruby wrapper object is garbage collected.
///
/// This can be implemented to perform Ruby-specific clean up when your
/// type is no longer referenced from Ruby, but it is likely easier to do
/// this in a [`Drop`] implementation for your type.
///
/// This function will always be called by Ruby on GC, it can not be opted
/// out of.
///
/// The default implementation simply drops `self`.
///
/// If this function (or the [`Drop`] implementation for your type) call
/// Ruby APIs you should not enable the `free_immediately` flag with the
/// [`wrap`](macro@crate::wrap)/[`TypedData`](macro@crate::TypedData)
/// macro or [`DataTypeBuilder::free_immediately`].
///
/// This function **must not** panic. The process will abort if this
/// function panics.
fn free(self: Box<Self>) {}
/// Called when Ruby marks this object as part of garbage collection.
///
/// If your type contains any Ruby values you must mark each of those
/// values in this function to avoid them being garbage collected.
///
/// This function is only called when the `mark` flag is set with the
/// [`wrap`](macro@crate::wrap)/[`TypedData`](macro@crate::TypedData)
/// macro or [`DataTypeBuilder::mark`].
///
/// The default implementation does nothing.
///
/// This function **must not** panic. The process will abort if this
/// function panics.
fn mark(&self, #[allow(unused_variables)] marker: &gc::Marker) {}
/// Called by Ruby to establish the memory size of this data, to optimise
/// when garbage collection happens.
///
/// This function is only called when the `size` flag is set with the
/// [`wrap`](macro@crate::wrap)/[`TypedData`](macro@crate::TypedData)
/// macro or [`DataTypeBuilder::mark`].
///
/// The default implementation delegates to [`std::mem::size_of_val`].
///
/// This function **must not** panic. The process will abort if this
/// function panics.
fn size(&self) -> usize {
size_of_val(self)
}
/// Called during garbage collection.
///
/// If your type contains any Ruby values that you have marked as moveable
/// in your [`mark`](Self::mark) function, you must update them in this
/// function using [`gc::Compactor::location`].
///
/// Ruby values would be concidered moveable if marked with the
/// [`gc::Marker::mark_movable`] function. Other marking functions such as
/// [`gc::Marker::mark`] will prevent values being moved.
///
/// As it is only safe for this function to receive a shared `&self`
/// reference, you must implement interior mutablility to be able to update
/// values. This is very hard to do correctly, and it is recommended to
/// simply avoid using [`gc::Marker::mark_movable`] and `compact`.
///
/// This function is only called when the `compact` flag is set with the
/// [`wrap`](macro@crate::wrap)/[`TypedData`](macro@crate::TypedData)
/// macro or [`DataTypeBuilder::mark`].
///
/// The default implementation does nothing.
///
/// This function **must not** panic. The process will abort if this
/// function panics.
fn compact(&self, #[allow(unused_variables)] compactor: &gc::Compactor) {}
/// Extern wrapper for `free`. Don't define or call.
///
/// # Safety
///
/// `ptr` must be a vaild pointer to a `Box<Self>`, and must not be aliased
/// This function will free the memory pointed to by `ptr`.
///
/// This function must not panic.
#[doc(hidden)]
unsafe extern "C" fn extern_free(ptr: *mut c_void) {
if let Err(e) = catch_unwind(|| Self::free(Box::from_raw(ptr as *mut _))) {
bug_from_panic(e, "panic in DataTypeFunctions::free")
}
}
/// Extern wrapper for `mark`. Don't define or call.
///
/// # Safety
///
/// `ptr` must be a vaild pointer to a `Self`, and must not be aliased.
///
/// This function must not panic.
#[doc(hidden)]
unsafe extern "C" fn extern_mark(ptr: *mut c_void) {
let marker = gc::Marker::new();
if let Err(e) = catch_unwind(|| Self::mark(&*(ptr as *mut Self), &marker)) {
bug_from_panic(e, "panic in DataTypeFunctions::mark")
}
}
/// Extern wrapper for `size`. Don't define or call.
///
/// # Safety
///
/// `ptr` must be a vaild pointer to a `Self`.
///
/// This function must not panic.
#[doc(hidden)]
unsafe extern "C" fn extern_size(ptr: *const c_void) -> size_t {
match catch_unwind(|| Self::size(&*(ptr as *const Self)) as size_t) {
Ok(v) => v,
Err(e) => bug_from_panic(e, "panic in DataTypeFunctions::size"),
}
}
/// Extern wrapper for `compact`. Don't define or call.
///
/// # Safety
///
/// `ptr` must be a vaild pointer to a `Self`, and must not be aliased.
///
/// This function must not panic.
#[doc(hidden)]
unsafe extern "C" fn extern_compact(ptr: *mut c_void) {
let compactor = gc::Compactor::new();
if let Err(e) = catch_unwind(|| Self::compact(&*(ptr as *mut Self), &compactor)) {
bug_from_panic(e, "panic in DataTypeFunctions::compact")
}
}
}
/// A builder for [`DataType`].
pub struct DataTypeBuilder<T> {
name: &'static CStr,
mark: bool,
size: bool,
compact: bool,
free_immediately: bool,
wb_protected: bool,
frozen_shareable: bool,
phantom: PhantomData<T>,
}
/// Create a new [`DataTypeBuilder`].
///
/// `name` should be unique per wrapped type. It does not need to be a
/// valid Ruby identifier.
///
/// `data_type_builder!(Example, "example")` is equivalent to
/// `DataTypeBuilder::<Example>::new` with a `name` argument of `"example"` as
/// a `'static CStr`.
#[macro_export]
macro_rules! data_type_builder {
($t:ty, $name:literal) => {
$crate::typed_data::DataTypeBuilder::<$t>::new(unsafe {
std::ffi::CStr::from_bytes_with_nul_unchecked(concat!($name, "\0").as_bytes())
})
};
}
impl<T> DataTypeBuilder<T>
where
T: DataTypeFunctions,
{
/// Create a new `DataTypeBuilder`.
///
/// `name` should be unique per wrapped type. It does not need to be a
/// valid Ruby identifier.
///
/// See [`data_type_builder`](macro@crate::data_type_builder) to create a
/// `DataTypeBuilder` with a `'static CStr` `name` from a string literal.
pub const fn new(name: &'static CStr) -> Self {
Self {
name,
mark: false,
size: false,
compact: false,
free_immediately: false,
wb_protected: false,
frozen_shareable: false,
phantom: PhantomData,
}
}
/// Enable using the the `mark` function from `<T as DataTypeFunctions>`.
pub const fn mark(mut self) -> Self {
self.mark = true;
self
}
/// Enable using the the `size` function from `<T as DataTypeFunctions>`.
pub const fn size(mut self) -> Self {
self.size = true;
self
}
/// Enable using the the `compact` function from `<T as DataTypeFunctions>`.
pub const fn compact(mut self) -> Self {
self.compact = true;
self
}
/// Enable the 'free_immediately' flag.
///
/// This is safe to do as long as the `<T as DataTypeFunctions>::free`
/// function or `T`'s drop function don't call Ruby in any way.
///
/// If safe this should be enabled as this performs better and is more
/// memory efficient.
pub const fn free_immediately(mut self) -> Self {
self.free_immediately = true;
self
}
/// Enable the 'write barrier protected' flag.
///
/// You almost certainly don't want to enable this.
pub const fn wb_protected(mut self) -> Self {
self.wb_protected = true;
self
}
/// Consume the builder and create a DataType.
pub const fn build(self) -> DataType {
let mut flags = 0_usize as VALUE;
if self.free_immediately {
flags |= RUBY_TYPED_FREE_IMMEDIATELY as VALUE;
}
if self.wb_protected || !self.mark {
flags |= RUBY_TYPED_WB_PROTECTED as VALUE;
}
#[cfg(ruby_gte_3_0)]
if self.frozen_shareable {
flags |= rbimpl_typeddata_flags::RUBY_TYPED_FROZEN_SHAREABLE as VALUE;
}
let dmark = if self.mark {
Some(T::extern_mark as _)
} else {
None
};
let dfree = Some(T::extern_free as _);
let dsize = if self.size {
Some(T::extern_size as _)
} else {
None
};
#[cfg(ruby_gte_2_7)]
let dcompact = if self.compact {
Some(T::extern_compact as _)
} else {
None
};
DataType(rb_data_type_t {
wrap_struct_name: self.name.as_ptr() as _,
function: rb_data_type_struct__bindgen_ty_1 {
dmark,
dfree,
dsize,
#[cfg(ruby_gte_2_7)]
dcompact,
#[cfg(ruby_gte_2_7)]
reserved: [ptr::null_mut(); 1],
#[cfg(ruby_lt_2_7)]
reserved: [ptr::null_mut(); 2],
},
parent: ptr::null(),
data: ptr::null_mut(),
flags,
})
}
}
impl<T> DataTypeBuilder<T>
where
T: DataTypeFunctions + Sync,
{
/// Enable the 'frozen_shareable' flag.
///
/// Set this if your type is thread safe when the Ruby wrapper object is
/// frozen.
pub const fn frozen_shareable(mut self) -> Self {
self.frozen_shareable = true;
self
}
}
/// A trait for Rust types that can be used with the
/// `rb_data_typed_object_wrap` API.
///
/// # Safety
///
/// This trait is unsafe to implement as the fields of [`DataType`] returned by
/// [`TypedData::data_type`] control low level behaviour that can go very wrong
/// if set incorrectly. Implementing this trait is the only way a [`DataType`]
/// can be passed to Ruby and result in safety violations, [`DataType`] is
/// otherwise safe (but useless) to create.
///
/// The [`TypedData`](`derive@crate::TypedData`) or [`wrap`](`crate::wrap`)
/// macros can help implementing this trait more safely.
pub unsafe trait TypedData
where
Self: Send + Sized,
{
/// Should return the class for the Ruby object wrapping the Rust type.
///
/// This can be overridden on a case by case basis by implementing
/// [`TypedData::class_for`], but the result of this function will always
/// be used in error messages if a value fails to convert to `Self`.
///
/// If using [`class_for`](Self::class_for) it is advised to have this
/// function return the superclass of those returned by `class_for`.
///
/// # Examples
///
/// ```
/// use magnus::{prelude::*, value::Lazy, RClass, Ruby, TypedData};
/// # use magnus::DataType;
///
/// struct Example();
///
/// unsafe impl TypedData for Example {
/// fn class(ruby: &Ruby) -> RClass {
/// static CLASS: Lazy<RClass> = Lazy::new(|ruby| {
/// let class = ruby.define_class("Example", ruby.class_object()).unwrap();
/// class.undef_default_alloc_func();
/// class
/// });
/// ruby.get_inner(&CLASS)
/// }
///
/// // ...
/// # fn data_type() -> &'static DataType { unimplemented!() }
/// }
/// ```
fn class(ruby: &Ruby) -> RClass;
/// Should return a static reference to a [`DataType`] with metadata about
/// the wrapped type.
///
/// # Examples
///
/// ```
/// use magnus::{data_type_builder, DataType, DataTypeFunctions, TypedData};
/// # use magnus::{RClass, Ruby};
///
/// #[derive(DataTypeFunctions)]
/// struct Example();
///
/// unsafe impl TypedData for Example {
/// # fn class(_: &Ruby) -> RClass { unimplemented!() }
/// // ...
///
/// fn data_type() -> &'static DataType {
/// static DATA_TYPE: DataType = data_type_builder!(Example, "example").build();
/// &DATA_TYPE
/// }
/// }
/// ```
fn data_type() -> &'static DataType;
/// Used to customise the class wrapping a specific value of `Self`.
///
/// The provided implementation simply returns the value of
/// [`TypedData::class`].
///
/// The classes returned by this function must be subclasses of
/// `TypedData::class`. `TypedData::class` will always be used in error
/// messages if a value fails to convert to `Self`.
///
/// See also [`Obj::wrap_as`]/[`RTypedData::wrap_as`].
///
/// # Examples
///
/// ```
/// use magnus::{prelude::*, value::Lazy, RClass, Ruby, TypedData};
/// # use magnus::DataType;
///
/// enum Example {
/// A,
/// B,
/// }
///
/// unsafe impl TypedData for Example {
/// # fn class(_: &Ruby) -> RClass { unimplemented!() }
/// # fn data_type() -> &'static DataType { unimplemented!() }
/// // ...
///
/// fn class_for(ruby: &Ruby, value: &Self) -> RClass {
/// static A: Lazy<RClass> = Lazy::new(|ruby| {
/// let class = ruby.define_class("A", Example::class(ruby)).unwrap();
/// class.undef_default_alloc_func();
/// class
/// });
/// static B: Lazy<RClass> = Lazy::new(|ruby| {
/// let class = ruby.define_class("B", Example::class(ruby)).unwrap();
/// class.undef_default_alloc_func();
/// class
/// });
/// match value {
/// Self::A => ruby.get_inner(&A),
/// Self::B => ruby.get_inner(&B),
/// }
/// }
/// }
/// # let _ = (Example::A, Example::B);
/// ```
#[allow(unused_variables)]
fn class_for(ruby: &Ruby, value: &Self) -> RClass {
Self::class(ruby)
}
}
impl<T> TryConvert for &T
where
T: TypedData,
{
fn try_convert(val: Value) -> Result<Self, Error> {
let handle = Ruby::get_with(val);
unsafe {
RTypedData::from_value(val)
.ok_or_else(|| {
Error::new(
handle.exception_type_error(),
format!(
"no implicit conversion of {} into {}",
val.classname(),
T::class(&handle)
),
)
})?
.get_unconstrained()
}
}
}
impl<T> IntoValue for T
where
T: TypedData,
{
#[inline]
fn into_value_with(self, handle: &Ruby) -> Value {
handle.wrap(self).into_value_with(handle)
}
}
/// A Ruby Object wrapping a Rust type `T`.
///
/// This is a Value pointer to a RTypedData struct, Ruby’s internal
/// representation of objects that wrap foreign types. Unlike [`RTypedData`] it
/// tracks the Rust type it should contains and errors early in [`TryConvert`]
/// if types don't match, rather than on [`Obj::get`].
///
/// See the [`ReprValue`] and [`Object`] traits for additional methods
/// available on this type. See [`Ruby`](Ruby#typed_dataobj) for methods to
/// create a `typed_data::Obj`.
#[repr(transparent)]
pub struct Obj<T> {
inner: RTypedData,
phantom: PhantomData<T>,
}
impl<T> Copy for Obj<T> where T: TypedData {}
impl<T> Clone for Obj<T>
where
T: TypedData,
{
fn clone(&self) -> Self {
*self
}
}
/// # `typed_data::Obj`
///
/// Functions to wrap Rust data in a Ruby object.
///
/// See also [`RTypedData`](Ruby#rtypeddata) and the [`typed_data::Obj`](Obj)
/// type.
impl Ruby {
/// Wrap the Rust type `T` in a Ruby object.
///
/// # Examples
///
/// ```
/// use magnus::{prelude::*, Error, Ruby};
///
/// #[magnus::wrap(class = "Point")]
/// struct Point {
/// x: isize,
/// y: isize,
/// }
///
/// fn example(ruby: &Ruby) -> Result<(), Error> {
/// let point_class = ruby.define_class("Point", ruby.class_object())?;
///
/// let value = ruby.obj_wrap(Point { x: 4, y: 2 });
/// assert!(value.is_kind_of(point_class));
///
/// Ok(())
/// }
/// # Ruby::init(example).unwrap();
/// # let _ = Point { x: 1, y: 2 }.x + Point { x: 3, y: 4 }.y;
/// ```
pub fn obj_wrap<T>(&self, data: T) -> Obj<T>
where
T: TypedData,
{
Obj {
inner: self.wrap(data),
phantom: PhantomData,
}
}
/// Wrap the Rust type `T` in a Ruby object that is an instance of the
/// given `class`.
///
/// See also [`TypedData::class_for`].
///
/// # Panics
///
/// Panics if `class` is not a subclass of `<T as TypedData>::class()`.
///
/// # Examples
///
/// ```
/// use magnus::{prelude::*, Error, Ruby};
///
/// #[magnus::wrap(class = "Point")]
/// struct Point {
/// x: isize,
/// y: isize,
/// }
///
/// fn example(ruby: &Ruby) -> Result<(), Error> {
/// let point_class = ruby.define_class("Point", ruby.class_object())?;
/// let point_sub_class = ruby.define_class("SubPoint", point_class)?;
///
/// let value = ruby.obj_wrap_as(Point { x: 4, y: 2 }, point_sub_class);
/// assert!(value.is_kind_of(point_sub_class));
/// assert!(value.is_kind_of(point_class));
///
/// Ok(())
/// }
/// # Ruby::init(example).unwrap();
/// # let _ = Point { x: 1, y: 2 }.x + Point { x: 3, y: 4 }.y;
/// ```
///
/// Allowing a wrapped type to be subclassed from Ruby:
///
/// (note, in this example `Point` does not have and does not call the
/// `initialize` method, subclasses would need to override the class `new`
/// method rather than `initialize`)
///
/// ```
/// use magnus::{function, method, prelude::*, typed_data, Error, RClass, Ruby, Value};
///
/// #[magnus::wrap(class = "Point")]
/// struct Point {
/// x: isize,
/// y: isize,
/// }
///
/// impl Point {
/// fn new(ruby: &Ruby, class: RClass, x: isize, y: isize) -> typed_data::Obj<Self> {
/// ruby.obj_wrap_as(Self { x, y }, class)
/// }
/// }
///
/// fn example(ruby: &Ruby) -> Result<(), Error> {
/// let point_class = ruby.define_class("Point", ruby.class_object())?;
/// point_class.define_singleton_method("new", method!(Point::new, 2))?;
/// point_class
/// .define_singleton_method("inherited", function!(RClass::undef_default_alloc_func, 1))?;
///
/// let value: Value = ruby.eval(
/// r#"
/// class SubPoint < Point
/// end
/// SubPoint.new(4, 2)
/// "#,
/// )?;
///
/// assert!(value.is_kind_of(ruby.class_object().const_get::<_, RClass>("SubPoint")?));
/// assert!(value.is_kind_of(point_class));
///
/// Ok(())
/// }
/// # Ruby::init(example).unwrap();
/// # let _ = Point { x: 1, y: 2 }.x + Point { x: 3, y: 4 }.y;
/// ```
pub fn obj_wrap_as<T>(&self, data: T, class: RClass) -> Obj<T>
where
T: TypedData,
{
Obj {
inner: self.wrap_as(data, class),
phantom: PhantomData,
}
}
}
impl<T> Obj<T>
where
T: TypedData,
{
/// Wrap the Rust type `T` in a Ruby object.
///
/// # Panics
///
/// Panics if called from a non-Ruby thread. See [`Ruby::obj_wrap`] for the
/// non-panicking version.
///
/// # Examples
///
/// ```
/// use magnus::{class, define_class, prelude::*, typed_data};
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// #[magnus::wrap(class = "Point")]
/// struct Point {
/// x: isize,
/// y: isize,
/// }
///
/// let point_class = define_class("Point", class::object()).unwrap();
///
/// let value = typed_data::Obj::wrap(Point { x: 4, y: 2 });
/// assert!(value.is_kind_of(point_class));
/// # let _ = Point { x: 1, y: 2 }.x + Point { x: 3, y: 4 }.y;
/// ```
#[cfg_attr(
not(feature = "friendly-api"),
deprecated(note = "please use `Ruby::obj_wrap` instead")
)]
#[inline]
pub fn wrap(data: T) -> Self {
get_ruby!().obj_wrap(data)
}
/// Wrap the Rust type `T` in a Ruby object that is an instance of the
/// given `class`.
///
/// See also [`TypedData::class_for`].
///
/// # Panics
///
/// Panics if `class` is not a subclass of `<T as TypedData>::class()`, or
/// if called from a non-Ruby thread. See [`Ruby::obj_wrap_as`] for a
/// version that can not be called from a non-Ruby thread, so will not
/// panic for that reason.
///
/// # Examples
///
/// ```
/// use magnus::{class, define_class, prelude::*, typed_data};
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// #[magnus::wrap(class = "Point")]
/// struct Point {
/// x: isize,
/// y: isize,
/// }
///
/// let point_class = define_class("Point", class::object()).unwrap();
/// let point_sub_class = define_class("SubPoint", point_class).unwrap();
///
/// let value = typed_data::Obj::wrap_as(Point { x: 4, y: 2 }, point_sub_class);
/// assert!(value.is_kind_of(point_sub_class));
/// assert!(value.is_kind_of(point_class));
/// # let _ = Point { x: 1, y: 2 }.x + Point { x: 3, y: 4 }.y;
/// ```
///
/// Allowing a wrapped type to be subclassed from Ruby:
///
/// (note, in this example `Point` does not have and does not call
/// the `initialize` method, subclasses would need to override the class
/// `new` method rather than `initialize`)
///
/// ```
/// use magnus::{
/// class, define_class, eval, function, method, prelude::*, typed_data, RClass, Value,
/// };
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// #[magnus::wrap(class = "Point")]
/// struct Point {
/// x: isize,
/// y: isize,
/// }
///
/// impl Point {
/// fn new(class: RClass, x: isize, y: isize) -> typed_data::Obj<Self> {
/// typed_data::Obj::wrap_as(Self { x, y }, class)
/// }
/// }
/// let point_class = define_class("Point", class::object()).unwrap();
/// point_class
/// .define_singleton_method("new", method!(Point::new, 2))
/// .unwrap();
/// point_class
/// .define_singleton_method("inherited", function!(RClass::undef_default_alloc_func, 1))
/// .unwrap();
///
/// let value: Value = eval(
/// r#"
/// class SubPoint < Point
/// end
/// SubPoint.new(4, 2)
/// "#,
/// )
/// .unwrap();
///
/// assert!(value.is_kind_of(class::object().const_get::<_, RClass>("SubPoint").unwrap()));
/// assert!(value.is_kind_of(point_class));
/// # let _ = Point { x: 1, y: 2 }.x + Point { x: 3, y: 4 }.y;
/// ```
#[cfg_attr(
not(feature = "friendly-api"),
deprecated(note = "please use `Ruby::obj_wrap_as` instead")
)]
#[inline]
pub fn wrap_as(data: T, class: RClass) -> Self {
get_ruby!().obj_wrap_as(data, class)
}
#[doc(hidden)]
#[deprecated(
since = "0.6.0",
note = "Obj::get() is unnecessary, Obj<T> derefs to T"
)]
pub fn get(&self) -> &T {
self.inner.get().unwrap()
}
}
impl<T> Deref for Obj<T>
where
T: TypedData,
{
type Target = T;
/// Dereference to the Rust type wrapped in the Ruby object `self`.
///
/// # Examples
///
/// ```
/// use magnus::{class, define_class, typed_data};
/// # let _cleanup = unsafe { magnus::embed::init() };
///
/// #[magnus::wrap(class = "Point")]
/// #[derive(Debug, PartialEq, Eq)]
/// struct Point {
/// x: isize,
/// y: isize,
/// }
///
/// define_class("Point", class::object()).unwrap();
/// let value = typed_data::Obj::wrap(Point { x: 4, y: 2 });
///
/// assert_eq!(&*value, &Point { x: 4, y: 2 });
/// ```
fn deref(&self) -> &Self::Target {
self.inner.get().unwrap()
}
}
impl<T> fmt::Display for Obj<T>
where
T: TypedData,
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", unsafe { self.to_s_infallible() })
}
}
impl<T> fmt::Debug for Obj<T>
where
T: TypedData,
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.inspect())
}
}
impl<T> IntoValue for Obj<T>
where
T: TypedData,
{
#[inline]
fn into_value_with(self, handle: &Ruby) -> Value {
self.inner.into_value_with(handle)
}
}
impl<T> From<Obj<T>> for RTypedData
where
T: TypedData,
{
fn from(val: Obj<T>) -> Self {
val.inner
}
}
impl<T> Object for Obj<T> where T: TypedData {}
unsafe impl<T> private::ReprValue for Obj<T> where T: TypedData {}
impl<T> ReprValue for Obj<T> where T: TypedData {}
impl<T> TryConvert for Obj<T>
where
T: TypedData,
{
fn try_convert(val: Value) -> Result<Self, Error> {
let handle = Ruby::get_with(val);
let inner = RTypedData::from_value(val).ok_or_else(|| {
Error::new(
handle.exception_type_error(),
format!(
"no implicit conversion of {} into {}",
unsafe { val.classname() },
T::class(&handle)
),
)
})?;
// check it really does contain a T
inner.get::<T>()?;
Ok(Self {
inner,
phantom: PhantomData,
})
}
}
/// Trait for a Ruby-compatible `#hash` method.
///
/// Automatically implemented for any type implementing [`std::hash::Hash`].
///
/// See also [`Dup`], [`Inspect`], [`IsEql`], and [`typed_data::Cmp`](Cmp).
///
/// # Examples
///
/// ```
/// use std::hash::Hasher;
///
/// use magnus::{
/// class, define_class, function, gc, method, prelude::*, typed_data, value::Opaque,
/// DataTypeFunctions, IntoValue, RHash, TypedData, Value,
/// };
///
/// #[derive(TypedData)]
/// #[magnus(class = "Pair", free_immediately, mark)]
/// struct Pair {
/// #[magnus(opaque_attr_reader)]
/// a: Opaque<Value>,
/// #[magnus(opaque_attr_reader)]
/// b: Opaque<Value>,
/// }
///
/// impl Pair {
/// fn new(a: Value, b: Value) -> Self {
/// Self {
/// a: a.into(),
/// b: b.into(),
/// }
/// }
/// }
///
/// impl DataTypeFunctions for Pair {
/// fn mark(&self, marker: &gc::Marker) {
/// marker.mark(self.a);
/// marker.mark(self.b);
/// }
/// }
///
/// impl std::hash::Hash for Pair {
/// fn hash<H: Hasher>(&self, state: &mut H) {
/// state.write_i64(
/// self.a()
/// .hash()
/// .expect("#hash should not fail")
/// .to_i64()
/// .expect("#hash result guaranteed to be <= i64"),
/// );
/// state.write_i64(
/// self.b()
/// .hash()
/// .expect("#hash should not fail")
/// .to_i64()
/// .expect("#hash result guaranteed to be <= i64"),
/// );
/// }
/// }
///
/// impl PartialEq for Pair {
/// fn eq(&self, other: &Self) -> bool {
/// self.a().eql(other.a()).unwrap_or(false) && self.b().eql(other.b()).unwrap_or(false)
/// }
/// }
///
/// impl Eq for Pair {}
///
/// # let _cleanup = unsafe { magnus::embed::init() };
/// #
/// let class = define_class("Pair", class::object()).unwrap();
/// class
/// .define_singleton_method("new", function!(Pair::new, 2))
/// .unwrap();
/// class
/// .define_method("hash", method!(<Pair as typed_data::Hash>::hash, 0))
/// .unwrap();
/// class
/// .define_method("eql?", method!(<Pair as typed_data::IsEql>::is_eql, 1))
/// .unwrap();
///
/// let a = Pair::new("foo".into_value(), 1.into_value());
/// let hash = RHash::new();
/// hash.aset(a, "test value").unwrap();
///
/// let b = Pair::new("foo".into_value(), 1.into_value());
/// assert_eq!("test value", hash.fetch::<_, String>(b).unwrap());
///
/// let c = Pair::new("bar".into_value(), 2.into_value());
/// assert!(hash.get(c).is_none());
/// ```
pub trait Hash {
// Docs at trait level.
#![allow(missing_docs)]
fn hash(&self) -> i64;
}
impl<T> Hash for T
where
T: std::hash::Hash,
{
fn hash(&self) -> i64 {
let mut hasher = DefaultHasher::new();
std::hash::Hash::hash(self, &mut hasher);
// Ensure the Rust usize hash converts nicely to Ruby's expected range
// if we return usize it'd truncate to 0 for anything negative.
hasher.finish() as i64
}
}
/// Trait for a Ruby-compatible `#eql?` method.
///
/// Automatically implemented for any type implementing [`Eq`] and
/// [`TryConvert`].
///
/// See also [`Dup`], [`Inspect`], [`typed_data::Cmp`](Cmp), and
/// [`typed_data::Hash`](Hash).
///
/// # Examples
///
/// ```
/// use std::hash::Hasher;
///
/// use magnus::{
/// class, define_class, function, gc, method, prelude::*, typed_data, value::Opaque,
/// DataTypeFunctions, IntoValue, RHash, TypedData, Value,
/// };
///
/// #[derive(TypedData)]
/// #[magnus(class = "Pair", free_immediately, mark)]
/// struct Pair {
/// #[magnus(opaque_attr_reader)]
/// a: Opaque<Value>,
/// #[magnus(opaque_attr_reader)]
/// b: Opaque<Value>,
/// }
///
/// impl Pair {
/// fn new(a: Value, b: Value) -> Self {
/// Self {
/// a: a.into(),
/// b: b.into(),
/// }
/// }
/// }
///
/// impl DataTypeFunctions for Pair {
/// fn mark(&self, marker: &gc::Marker) {
/// marker.mark(self.a);
/// marker.mark(self.b);
/// }
/// }
///
/// impl std::hash::Hash for Pair {
/// fn hash<H: Hasher>(&self, state: &mut H) {
/// state.write_i64(
/// self.a()
/// .hash()
/// .expect("#hash should not fail")
/// .to_i64()
/// .expect("#hash result guaranteed to be <= i64"),
/// );
/// state.write_i64(
/// self.b()
/// .hash()
/// .expect("#hash should not fail")
/// .to_i64()
/// .expect("#hash result guaranteed to be <= i64"),
/// );
/// }
/// }
///
/// impl PartialEq for Pair {
/// fn eq(&self, other: &Self) -> bool {
/// self.a().eql(other.a()).unwrap_or(false) && self.b().eql(other.b()).unwrap_or(false)
/// }
/// }
///
/// impl Eq for Pair {}
///
/// # let _cleanup = unsafe { magnus::embed::init() };
/// #
/// let class = define_class("Pair", class::object()).unwrap();
/// class
/// .define_singleton_method("new", function!(Pair::new, 2))
/// .unwrap();
/// class
/// .define_method("hash", method!(<Pair as typed_data::Hash>::hash, 0))
/// .unwrap();
/// class
/// .define_method("eql?", method!(<Pair as typed_data::IsEql>::is_eql, 1))
/// .unwrap();
///
/// let a = Pair::new("foo".into_value(), 1.into_value());
/// let hash = RHash::new();
/// hash.aset(a, "test value").unwrap();
///
/// let b = Pair::new("foo".into_value(), 1.into_value());
/// assert_eq!("test value", hash.fetch::<_, String>(b).unwrap());
///
/// let c = Pair::new("bar".into_value(), 2.into_value());
/// assert!(hash.get(c).is_none());
/// ```
pub trait IsEql {
// Docs at trait level.
#![allow(missing_docs)]
fn is_eql(&self, other: Value) -> bool;
}
impl<'a, T> IsEql for T
where
T: Eq + 'a,
&'a T: TryConvert,
{
fn is_eql(&self, other: Value) -> bool {
<&'a T>::try_convert(other)
.map(|o| self == o)
.unwrap_or(false)
}
}
/// Trait for a Ruby-compatible `#<=>` method.
///
/// Automatically implemented for any type implementing [`PartialOrd`] and
/// [`TryConvert`].
///
/// See also [`Dup`], [`Inspect`], [`IsEql`] and [`typed_data::Hash`](Hash).
///
/// # Examples
///
/// ```
/// use std::cmp::Ordering;
///
/// use magnus::{
/// class, define_class, function, gc, method, module, prelude::*, rb_assert, typed_data,
/// value::Opaque, DataTypeFunctions, IntoValue, Module, TypedData, Value,
/// };
///
/// #[derive(TypedData)]
/// #[magnus(class = "Pair", free_immediately, mark)]
/// struct Pair {
/// #[magnus(opaque_attr_reader)]
/// a: Opaque<Value>,
/// #[magnus(opaque_attr_reader)]
/// b: Opaque<Value>,
/// }
///
/// impl Pair {
/// fn new(a: Value, b: Value) -> Self {
/// Self {
/// a: a.into(),
/// b: b.into(),
/// }
/// }
/// }
///
/// impl DataTypeFunctions for Pair {
/// fn mark(&self, marker: &gc::Marker) {
/// marker.mark(self.a);
/// marker.mark(self.b);
/// }
/// }
///
/// impl PartialEq for Pair {
/// fn eq(&self, other: &Self) -> bool {
/// self.a().eql(other.a()).unwrap_or(false) && self.b().eql(other.b()).unwrap_or(false)
/// }
/// }
///
/// impl PartialOrd for Pair {
/// fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
/// let a = self
/// .a()
/// .funcall("<=>", (other.a(),))
/// .ok()
/// .map(|o: i64| o.cmp(&0))?;
/// match a {
/// Ordering::Less | Ordering::Greater => Some(a),
/// Ordering::Equal => self
/// .b()
/// .funcall("<=>", (other.b(),))
/// .ok()
/// .map(|o: i64| o.cmp(&0)),
/// }
/// }
/// }
///
/// # let _cleanup = unsafe { magnus::embed::init() };
/// #
/// let class = define_class("Pair", class::object()).unwrap();
/// class
/// .define_singleton_method("new", function!(Pair::new, 2))
/// .unwrap();
/// class
/// .define_method("<=>", method!(<Pair as typed_data::Cmp>::cmp, 1))
/// .unwrap();
/// class.include_module(module::comparable()).unwrap();
///
/// let a = Pair::new("foo".into_value(), 1.into_value());
/// let b = Pair::new("foo".into_value(), 2.into_value());
/// rb_assert!("a < b", a, b);
///
/// let b = Pair::new("foo".into_value(), 2.into_value());
/// let c = Pair::new("bar".into_value(), 3.into_value());
/// rb_assert!("b > c", b, c);
///
/// let a = Pair::new("foo".into_value(), 1.into_value());
/// let b = Pair::new("foo".into_value(), 2.into_value());
/// rb_assert!("(a <=> b) == -1", a, b);
/// ```
pub trait Cmp {
// Docs at trait level.
#![allow(missing_docs)]
fn cmp(&self, other: Value) -> Option<i64>;
}
impl<'a, T> Cmp for T
where
T: PartialOrd + 'a,
&'a T: TryConvert,
{
fn cmp(&self, other: Value) -> Option<i64> {
<&'a T>::try_convert(other)
.ok()
.and_then(|o| self.partial_cmp(o))
.map(|o| o as i64)
}
}
/// Trait for a Ruby-compatible `#inspect` method.
///
/// Automatically implemented for any type implementing [`Debug`].
///
/// See also [`Dup`], [`IsEql`], [`typed_data::Cmp`](Cmp), and
/// [`typed_data::Hash`](Hash).
///
/// # Examples
///
/// ```
/// use std::fmt;
///
/// use magnus::{
/// class, define_class, function, gc, method, prelude::*, rb_assert, typed_data,
/// value::Opaque, DataTypeFunctions, IntoValue, TypedData, Value,
/// };
///
/// #[derive(TypedData)]
/// #[magnus(class = "Pair", free_immediately, mark)]
/// struct Pair {
/// #[magnus(opaque_attr_reader)]
/// a: Opaque<Value>,
/// #[magnus(opaque_attr_reader)]
/// b: Opaque<Value>,
/// }
///
/// impl Pair {
/// fn new(a: Value, b: Value) -> Self {
/// Self {
/// a: a.into(),
/// b: b.into(),
/// }
/// }
/// }
///
/// impl DataTypeFunctions for Pair {
/// fn mark(&self, marker: &gc::Marker) {
/// marker.mark(self.a);
/// marker.mark(self.b);
/// }
/// }
///
/// impl fmt::Debug for Pair {
/// fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
/// f.debug_struct("Pair")
/// .field("a", &self.a())
/// .field("b", &self.b())
/// .finish()
/// }
/// }
///
/// # let _cleanup = unsafe { magnus::embed::init() };
/// #
/// let class = define_class("Pair", class::object()).unwrap();
/// class
/// .define_singleton_method("new", function!(Pair::new, 2))
/// .unwrap();
/// class
/// .define_method(
/// "inspect",
/// method!(<Pair as typed_data::Inspect>::inspect, 0),
/// )
/// .unwrap();
///
/// let pair = Pair::new("foo".into_value(), 1.into_value());
/// rb_assert!(r#"pair.inspect == "Pair { a: \"foo\", b: 1 }""#, pair);
/// ```
pub trait Inspect {
// Docs at trait level.
#![allow(missing_docs)]
fn inspect(&self) -> String;
}
impl<T> Inspect for T
where
T: fmt::Debug,
{
fn inspect(&self) -> String {
format!("{:?}", self)
}
}
/// Trait for a Ruby-compatible `#dup` and `#clone` methods.
///
/// Automatically implemented for any type implementing [`Clone`].
///
/// See also [`Inspect`], [`IsEql`], [`typed_data::Cmp`](Cmp), and
/// [`typed_data::Hash`](Hash).
///
/// # Examples
///
/// ```
/// use magnus::{
/// class, define_class, function, gc, method, prelude::*, rb_assert, typed_data,
/// value::Opaque, DataTypeFunctions, IntoValue, TypedData, Value,
/// };
///
/// #[derive(TypedData, Clone)]
/// #[magnus(class = "Pair", free_immediately, mark)]
/// struct Pair {
/// a: Opaque<Value>,
/// b: Opaque<Value>,
/// }
///
/// impl Pair {
/// fn new(a: Value, b: Value) -> Self {
/// Self {
/// a: a.into(),
/// b: b.into(),
/// }
/// }
/// }
///
/// impl DataTypeFunctions for Pair {
/// fn mark(&self, marker: &gc::Marker) {
/// marker.mark(self.a);
/// marker.mark(self.b);
/// }
/// }
///
/// # let _cleanup = unsafe { magnus::embed::init() };
/// #
/// let class = define_class("Pair", class::object()).unwrap();
/// class
/// .define_singleton_method("new", function!(Pair::new, 2))
/// .unwrap();
/// class
/// .define_method("dup", method!(<Pair as typed_data::Dup>::dup, 0))
/// .unwrap();
/// class
/// .define_method("clone", method!(<Pair as typed_data::Dup>::clone, -1))
/// .unwrap();
///
/// let a = Pair::new("foo".into_value(), 1.into_value());
/// rb_assert!("b = a.dup; a.object_id != b.object_id", a);
/// ```
pub trait Dup: Sized {
// Docs at trait level.
#![allow(missing_docs)]
fn dup(&self) -> Self;
fn clone(rbself: Obj<Self>, args: &[Value]) -> Result<Obj<Self>, Error>;
}
impl<T> Dup for T
where
T: Clone + TypedData,
{
fn dup(&self) -> Self {
self.clone()
}
fn clone(rbself: Obj<Self>, args: &[Value]) -> Result<Obj<Self>, Error> {
let args = scan_args::<(), (), (), (), _, ()>(args)?;
let kwargs =
get_kwargs::<_, (), (Option<Option<bool>>,), ()>(args.keywords, &[], &["freeze"])?;
let (freeze,) = kwargs.optional;
let freeze = freeze.flatten();
let clone = Ruby::get_with(rbself).obj_wrap((*rbself).clone());
let class_clone = unsafe { rb_singleton_class_clone(rbself.as_rb_value()) };
unsafe { rb_obj_reveal(clone.as_rb_value(), class_clone) };
unsafe { rb_singleton_class_attached(class_clone, clone.as_rb_value()) };
match freeze {
Some(true) => clone.freeze(),
None if rbself.is_frozen() => clone.freeze(),
_ => (),
}
Ok(clone)
}
}